{ "openapi": "3.0.1", "info": { "title": "Omnium OMS Public API", "description": "Welcome to the Omnium OMS Public API swagger documentation.
For additional information, getting started guides and a technical overview, you'll find everything you need at docs.omnium.no. For general information on Omnium, please visit omnium.no.
Questions? Feel free to submit a ticket through our Help Center.", "version": "v1" }, "paths": { "/api/Accounting/Postings/{id}": { "get": { "tags": [ "Accounting | Postings" ], "summary": "Get a single accounting posting by ID.", "operationId": "AccountingGetPosting", "parameters": [ { "name": "id", "in": "path", "description": "Posting ID", "required": true, "schema": { "type": "string", "description": "Posting ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Posting found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } } } }, "400": { "description": "Posting ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Posting does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Accounting/Postings/ByZReport/{zReportId}": { "get": { "tags": [ "Accounting | Postings" ], "summary": "Get the (current, non-Superseded) accounting posting built from a given Z-report.", "operationId": "AccountingGetPostingByZReport", "parameters": [ { "name": "zReportId", "in": "path", "description": "Z-report ID", "required": true, "schema": { "type": "string", "description": "Z-report ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Posting found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPosting" } } } }, "400": { "description": "Z-report ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "No posting exists for the given Z-report", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Accounting/Postings/Search": { "post": { "tags": [ "Accounting | Postings" ], "summary": "Search accounting postings.", "operationId": "AccountingSearchPostings", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search results returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingPostingOmniumSearchResult" } } } }, "400": { "description": "Invalid page size or pagination", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Accounting/Postings/{id}/Lines": { "get": { "tags": [ "Accounting | Ledger Lines" ], "summary": "Get all ledger lines for a given posting.", "operationId": "AccountingGetLinesForPosting", "parameters": [ { "name": "id", "in": "path", "description": "Posting ID", "required": true, "schema": { "type": "string", "description": "Posting ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Ledger lines returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } } } } }, "400": { "description": "Posting ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Accounting/Postings/{postingId}/Lines/{id}": { "get": { "tags": [ "Accounting | Ledger Lines" ], "summary": "Get a single ledger line by ID. The posting ID is required because ledger lines are\r\npartitioned by posting in storage.", "operationId": "AccountingGetLine", "parameters": [ { "name": "postingId", "in": "path", "description": "ID of the parent posting", "required": true, "schema": { "type": "string", "description": "ID of the parent posting", "nullable": true } }, { "name": "id", "in": "path", "description": "Ledger line ID", "required": true, "schema": { "type": "string", "description": "Ledger line ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Ledger line found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" } } } }, "400": { "description": "IDs are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Ledger line does not exist on this posting", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Accounting/LedgerLines/Search": { "post": { "tags": [ "Accounting | Ledger Lines" ], "summary": "Search accounting ledger lines.", "operationId": "AccountingSearchLedgerLines", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search results returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAccountingLedgerLineOmniumSearchResult" } } } }, "400": { "description": "Invalid page size or pagination", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/AnalyticsOrders/Search": { "post": { "tags": [ "Orders | Analytics" ], "summary": "Search and filtering of analytics order lines", "operationId": "AnalyticsOrdersSearchAnalyticsOrderLines", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/AnalyticsOrders/SearchGrouped": { "post": { "tags": [ "Orders | Analytics" ], "summary": "Search for grouped analytics order lines", "operationId": "AnalyticsOrdersSearchOrderLinesGrouped", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGroupedSearchResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGroupedSearchResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGroupedSearchResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomer/{businessCustomerId}/Assets/GetAssets": { "get": { "tags": [ "Customers | B2B | Assets" ], "summary": "Get customer assets", "description": "Get customer assets by asset IDs", "operationId": "BusinessCustomerAssetsGetAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning assets", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "BusinessCustomer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/BusinessCustomer/{businessCustomerId}/Assets/AddAsset": { "post": { "tags": [ "Customers | B2B | Assets" ], "summary": "Add asset to customer from stream", "description": "Add new customer asset from stream", "operationId": "BusinessCustomerAssetsAddAsset", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "fileName", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "BusinessCustomer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/BusinessCustomer/{businessCustomerId}/Assets/AddAssets": { "post": { "tags": [ "Customers | B2B | Assets" ], "summary": "Add assets to customer", "description": "Add new customer assets", "operationId": "BusinessCustomerAssetsAddAssets", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "BusinessCustomer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/BusinessCustomer/{businessCustomerId}/Assets/UpdateAssets": { "post": { "tags": [ "Customers | B2B | Assets" ], "summary": "Update asset to customer", "description": "Update existing customer assets", "operationId": "BusinessCustomerAssetsUpdateAssets", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "BusinessCustomer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/BusinessCustomer/{businessCustomerId}/Assets/DeleteAssets": { "delete": { "tags": [ "Customers | B2B | Assets" ], "summary": "Delete assets from customers", "description": "Delete customer assets by asset IDs", "operationId": "BusinessCustomerAssetsDeleteAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset deleted successfully" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "BusinessCustomer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "BusinessCustomer ID or url missing" } } } }, "/api/BusinessCustomer/{businessCustomerId}/ContactPerson/GetContactPersons": { "get": { "tags": [ "Customers | B2B | Contact persons" ], "summary": "Get contact persons on business customer", "operationId": "BusinessCustomerContactPersonGetContactPersons", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomer/{businessCustomerId}/ContactPerson/AddContactPerson": { "put": { "tags": [ "Customers | B2B | Contact persons" ], "summary": "Add contact person to business customer. Replace if contact person with the same id, email or phone already exists.", "operationId": "BusinessCustomerContactPersonAddContactPerson", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumContactPerson" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumContactPerson" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumContactPerson" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumContactPerson" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomer/{businessCustomerId}/ContactPerson/DeleteContactPerson": { "delete": { "tags": [ "Customers | B2B | Contact persons" ], "summary": "Deletes the contact person with matching id, email or phone.", "operationId": "BusinessCustomerContactPersonDeleteContactPerson", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "contactPersonId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "contactPersonEmail", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "contactPersonPhone", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers": { "post": { "tags": [ "Customers | B2B" ], "summary": "Add business customer to database", "operationId": "BusinessCustomersPost", "requestBody": { "description": "The business customer to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/Update": { "post": { "tags": [ "Customers | B2B" ], "summary": "Update business customer", "operationId": "BusinessCustomersUpdate", "requestBody": { "description": "The customer to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The customer to update, with the given customerId, was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/PatchBusinessCustomer": { "patch": { "tags": [ "Customers | B2B" ], "summary": "Patch business customer - update only some values in request", "operationId": "BusinessCustomersPatchBusinessCustomer", "requestBody": { "description": "Business customer patch. Only properties with value will be updated.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Business customer updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } } } }, "400": { "description": "Business customer patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/AddOrUpdateMany": { "put": { "tags": [ "Customers | B2B" ], "summary": "Add or update a range of customers to the OMS.\r\nMax size in batch is 100", "operationId": "BusinessCustomersAddOrUpdateMany", "parameters": [ { "name": "enrichContactsFromPrivateCustomers", "in": "query", "description": "If true then Omnium will attempt to enrich the contacts with info from existing private customers in Omnium \r\n based on the given PrivateCustomerId on the contact. NB! The info sent in the request body will override the enriched values.", "schema": { "type": "boolean", "description": "If true then Omnium will attempt to enrich the contacts with info from existing private customers in Omnium \r\n based on the given PrivateCustomerId on the contact. NB! The info sent in the request body will override the enriched values.", "nullable": true } }, { "name": "exportBusinessCustomers", "in": "query", "description": "Whether the business customers should be exported", "schema": { "type": "boolean", "description": "Whether the business customers should be exported", "default": false } } ], "requestBody": { "description": "A list of business customer objects that needs to be added/updated to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "description": "A list of business customer objects that needs to be added/updated to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "description": "A list of business customer objects that needs to be added/updated to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "description": "A list of business customer objects that needs to be added/updated to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "description": "A list of business customer objects that needs to be added/updated to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/GetBusinessCustomerByContactPhone": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get business customers by searching for phone number of contact person", "operationId": "BusinessCustomersGetBusinessCustomerByContactPhone", "parameters": [ { "name": "phoneNumber", "in": "query", "description": "Phone number of contact person", "required": true, "schema": { "type": "string", "description": "Phone number of contact person" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/GetBusinessCustomerByContactPrivateCustomerId": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get business customers by searching for contact person private customer ID", "operationId": "BusinessCustomersGetBusinessCustomerByContactPrivateCustomerId", "parameters": [ { "name": "privateCustomerId", "in": "query", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/GetBusinessCustomerByContactEmail": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get business customers by searching for e-mail of contact person", "operationId": "BusinessCustomersGetBusinessCustomerByContactEmail", "parameters": [ { "name": "email", "in": "query", "description": "Email of contact person", "required": true, "schema": { "type": "string", "description": "Email of contact person" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/{id}": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get business customer by ID", "operationId": "BusinessCustomersGet", "parameters": [ { "name": "id", "in": "path", "description": "Customer ID", "required": true, "schema": { "type": "string", "description": "Customer ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "404": { "description": "Business customer with the given id was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Customers | B2B" ], "summary": "Delete business customer", "operationId": "BusinessCustomersDeleteBusinessCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Business customer ID", "required": true, "schema": { "type": "string", "description": "Business customer ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Customer is deleted" }, "404": { "description": "Customer does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/Search": { "get": { "tags": [ "Customers | B2B" ], "summary": "Free text search for business customers", "operationId": "BusinessCustomerFreeTextSearch", "parameters": [ { "name": "query", "in": "query", "description": "Search query", "schema": { "type": "string", "description": "Search query", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } } } } }, "deprecated": true }, "post": { "tags": [ "Customers | B2B" ], "summary": "Search business customers", "operationId": "BusinessCustomersSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning items found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/GetAll": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get all business customers, or get all business customers that has been changed since a given date and time.", "operationId": "BusinessCustomersGetAll", "parameters": [ { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32" } }, { "name": "sortOrder", "in": "query", "description": "Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending", "schema": { "type": "string", "description": "Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Customers added or modified since a given date and time", "schema": { "type": "string", "description": "Customers added or modified since a given date and time", "format": "date-time", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } } } } } } }, "/api/BusinessCustomers/{id}/SalesLimitations": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get all sales limitations for the customer.", "operationId": "BusinessCustomersGetSalesLimitationsForCustomer", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } }, { "name": "marketId", "in": "query", "description": "Market ID for the the customer", "schema": { "type": "string", "description": "Market ID for the the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } } } } } } }, "/api/BusinessCustomers/SalesLimitations": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get all sales limitations all customers.", "operationId": "BusinessCustomersGetSalesLimitations", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSalesLimitation" } } } } } } } }, "/api/BusinessCustomers/Scroll": { "post": { "tags": [ "Customers | B2B" ], "summary": "Scroll business Customer by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.", "operationId": "BusinessCustomersScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning business customers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/BusinessCustomers/Scroll/{id}": { "get": { "tags": [ "Customers | B2B" ], "summary": "Scroll is used to get a large amount of business customers.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "BusinessCustomersScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomerOmniumSearchResult" } } } } } } }, "/api/BusinessCustomers/SendEmailToCustomer/{businessCustomerId}": { "post": { "tags": [ "Customers | B2B" ], "summary": "Send email to business customer. Gets logged as note to customer. Consider using Notifications/SendEmail for more general purposes.", "operationId": "BusinessCustomersSendEmailToCustomer", "parameters": [ { "name": "businessCustomerId", "in": "path", "description": "Customer", "required": true, "schema": { "type": "string", "description": "Customer", "nullable": true } } ], "requestBody": { "description": "E-mail-message to send", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Email is sent" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Email is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/DeleteAll": { "delete": { "tags": [ "Customers | B2B" ], "summary": "Deleting ALL items! For development environments ONLY", "operationId": "BusinessCustomersDeleteAll", "parameters": [ { "name": "safeword", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "tenantId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/UpdateCustomerNumber": { "post": { "tags": [ "Customers | B2B" ], "summary": "Update customer number on customer and all orders", "operationId": "BusinessCustomersUpdateCustomerNumber", "parameters": [ { "name": "customerId", "in": "query", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer" } }, { "name": "customerNumber", "in": "query", "description": "The new customer number to be added", "required": true, "schema": { "type": "string", "description": "The new customer number to be added" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The customer was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/BusinessCustomers/GetNextCustomerNumber": { "get": { "tags": [ "Customers | B2B" ], "summary": "Get next generated customer number.", "description": "Requires that CustomerNumberOptions is configured, with auto create enabled.", "operationId": "BusinessCustomersGetNextCustomerNumber", "parameters": [ { "name": "marketId", "in": "query", "description": "Optional: Provide if multiple CustomerNumberOptions configured", "schema": { "type": "string", "description": "Optional: Provide if multiple CustomerNumberOptions configured", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "CustomerNumber", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "CustomerNumber not available", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "NumberOptions not configured", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Campaigns/{id}": { "get": { "tags": [ "Promotions | Campaigns" ], "summary": "Returns a single campaign", "operationId": "CampaignsGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign to return", "required": true, "schema": { "type": "string", "description": "ID of the campaign to return", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } } } }, "404": { "description": "The campaign was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Promotions | Campaigns" ], "summary": "Update an existing campaign", "operationId": "CampaignsUpdate", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign to update", "required": true, "schema": { "type": "string", "description": "ID of the campaign to update", "nullable": true } } ], "requestBody": { "description": "Updated campaign data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Promotions | Campaigns" ], "summary": "Delete a campaign", "operationId": "CampaignsDelete", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign to delete", "required": true, "schema": { "type": "string", "description": "ID of the campaign to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Campaigns/Search": { "post": { "tags": [ "Promotions | Campaigns" ], "summary": "Search for campaigns", "operationId": "CampaignsSearch", "requestBody": { "description": "Search filters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCampaignOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Campaigns": { "post": { "tags": [ "Promotions | Campaigns" ], "summary": "Create a new campaign", "operationId": "CampaignsCreate", "requestBody": { "description": "Campaign data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Campaigns/{id}/status": { "patch": { "tags": [ "Promotions | Campaigns" ], "summary": "Update the status of a campaign", "operationId": "CampaignsUpdateStatus", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign", "required": true, "schema": { "type": "string", "description": "ID of the campaign", "nullable": true } } ], "requestBody": { "description": "The new status", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignStatusUpdate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignStatusUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignStatusUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCampaignStatusUpdate" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCampaign" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Campaigns/{id}/promotions": { "get": { "tags": [ "Promotions | Campaigns" ], "summary": "Get promotion IDs linked to a campaign", "operationId": "CampaignsGetLinkedPromotions", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign", "required": true, "schema": { "type": "string", "description": "ID of the campaign", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/DeleteShipments": { "delete": { "tags": [ "Carts | Checkout" ], "summary": "Delete shipments from cart", "description": "Delete shipments from cart.", "operationId": "CartDeleteShipments", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "schema": { "type": "string", "description": "Cart ID" } } ], "requestBody": { "description": "Shipment IDs to delete", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}": { "get": { "tags": [ "Carts | Get" ], "summary": "Get cart by ID", "operationId": "CartGet", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart found and is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Carts | Update" ], "summary": "Delete cart", "operationId": "CartDeleteCart", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Cart is deleted" }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Cart/OrderLines/CreateCart": { "put": { "tags": [ "Carts | Add" ], "summary": "Add item to new cart", "operationId": "CartCreateCartFromOrderLine", "parameters": [ { "name": "marketId", "in": "query", "description": "Market ID for new cart (using default if null)", "schema": { "type": "string", "description": "Market ID for new cart (using default if null)", "nullable": true } } ], "requestBody": { "description": "Order line to add to new cart", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Item is added and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/CreateCart": { "post": { "tags": [ "Carts | Update" ], "summary": "Create new empty cart", "operationId": "CartCreateCart", "parameters": [ { "name": "marketId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "New cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddProductOptionsItemToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add product options to cart with an existing order line.", "description": "This endpoint allows adding additional product options like engraving, customizations or additional services to an existing product in the cart.\r\n

\r\nBelow you'll find a sample request for adding two product options (engraving and font type) to a cart with id C1234, to order line with LineItemId \"a43707ab-1ebf-4114-8c48-eb0374932a4c\", which in this case is a diamond ring.\r\n
\r\nThe product options \"P3\" and \"P5\" should be valid SKUs for products in Omnium, with product type set to ProductOption.\r\n
\r\nThe price for the product option will set from A: a specific price set in the parameter price, as displayed below. B: The price specified for the product option. C: The price specified for the product matching the sku.\r\n \r\n POST /api/carts/AddProductOptionsItemToCart\r\n {\r\n {\r\n \"cartId\": \"C1234\", // The unique identifier of the cart\r\n \"parentLineItemId\": \"a43707ab-1ebf-4114-8c48-eb0374932a4c\", // The ID of the existing order line to which product options are added\r\n \"productOptions\": [\r\n {\r\n \"skuId\": \"P3\", // SKU ID of the product option\r\n \"title\": \"Font type\", // Name of the product option\r\n \"value\": \"Big and bold\" // The selected option value\r\n \"price\": 199 // Optional: If you do not et the price in the request, the price will be fetched from the product in Omnium\r\n },\r\n {\r\n \"skuId\": \"P5\",\r\n \"title\": \"Engraving\",\r\n \"value\": \"omnium4ever\"\r\n },\r\n {\r\n \"skuId\": \"P8\" // It would often be sufficient to only use the skuId. The price and values would then fall back to the product option or the store product\r\n }\r\n ]\r\n }\r\n }\r\n \r\n \r\nThis would add three additional order lines to the cart, which would result in a diamond ring engraved with \"omnium4ever\" with font type \"Big and bold\", and also the option \"P8\" which in this case is an ultra nice gift box 💍\r\n
", "operationId": "CartAddProductOptionsItemToCart", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAddProductOptionsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAddProductOptionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAddProductOptionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAddProductOptionsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Item is added and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddItemToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add item to new or existing cart", "operationId": "CartAddItemToCart", "parameters": [ { "name": "cartId", "in": "query", "description": "ID of existing cart. If null, new cart will be created", "schema": { "type": "string", "description": "ID of existing cart. If null, new cart will be created", "nullable": true } }, { "name": "skuId", "in": "query", "description": "Product SKU id. (Required)", "required": true, "schema": { "type": "string", "description": "Product SKU id. (Required)" } }, { "name": "quantity", "in": "query", "description": "Quantity to add. Defaults to 1 if not provided. If unitId is specified then this refers to the units quantity.", "schema": { "type": "number", "description": "Quantity to add. Defaults to 1 if not provided. If unitId is specified then this refers to the units quantity.", "format": "decimal", "nullable": true } }, { "name": "marketId", "in": "query", "description": "Market ID for new cart - default market if null", "schema": { "type": "string", "description": "Market ID for new cart - default market if null", "nullable": true } }, { "name": "storeId", "in": "query", "description": "Store ID for new cart - defaults to null", "schema": { "type": "string", "description": "Store ID for new cart - defaults to null", "nullable": true } }, { "name": "customerId", "in": "query", "description": "CustomerId for the new cart - defaults to null", "schema": { "type": "string", "description": "CustomerId for the new cart - defaults to null", "nullable": true } }, { "name": "warehouseCode", "in": "query", "description": "Optional - WarehouseCode for orderline fulfillment warehouse. If set the order line will be added to a shipment with the specified warehouseCode.", "schema": { "type": "string", "description": "Optional - WarehouseCode for orderline fulfillment warehouse. If set the order line will be added to a shipment with the specified warehouseCode.", "nullable": true } }, { "name": "unitId", "in": "query", "description": "EAN for product unit - If set then the quantity will refer to the unit's quantity. If no matching unit price is found we will fallback to default unit and price", "schema": { "type": "string", "description": "EAN for product unit - If set then the quantity will refer to the unit's quantity. If no matching unit price is found we will fallback to default unit and price", "nullable": true } }, { "name": "forceNewOrderLine", "in": "query", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku", "schema": { "type": "boolean", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku" } }, { "name": "priceStoreId", "in": "query", "description": "Only use when buying from a store with a higher unit price than the default price", "schema": { "type": "string", "description": "Only use when buying from a store with a higher unit price than the default price", "nullable": true } }, { "name": "preventAutomaticOrderLineShipmentAssignment", "in": "query", "description": "Omnium will automatically assign new line items to existing shipments. If the cart shipment contains a shipment but the orderline should be kept outside the shipment set this propery to true.", "schema": { "type": "boolean", "description": "Omnium will automatically assign new line items to existing shipments. If the cart shipment contains a shipment but the orderline should be kept outside the shipment set this propery to true.", "nullable": true } }, { "name": "allowNoPriceItems", "in": "query", "description": "Allow adding items without a price (they will get price = 0)", "schema": { "type": "boolean", "description": "Allow adding items without a price (they will get price = 0)", "default": false } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Cart is created and item added. Updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "200": { "description": "Item is added to existing cart and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddItemsToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add items to new or existing cart", "operationId": "CartAddItemsToCart", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartUpdateRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Cart is created and items are added. The updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "200": { "description": "Items are added to existing cart and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddManyItemsToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add many items to new or existing cart", "operationId": "CartAddManyItemsToCart", "parameters": [ { "name": "cartId", "in": "query", "description": "ID of existing cart. If null, new cart will be created", "schema": { "type": "string", "description": "ID of existing cart. If null, new cart will be created", "nullable": true } }, { "name": "marketId", "in": "query", "description": "Market ID for new cart - default market if null", "schema": { "type": "string", "description": "Market ID for new cart - default market if null", "nullable": true } }, { "name": "storeId", "in": "query", "description": "Store ID for new cart - defaults to null", "schema": { "type": "string", "description": "Store ID for new cart - defaults to null", "nullable": true } }, { "name": "customerId", "in": "query", "description": "CustomerId for the new cart - defaults to null", "schema": { "type": "string", "description": "CustomerId for the new cart - defaults to null", "nullable": true } }, { "name": "forceNewOrderLine", "in": "query", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku", "schema": { "type": "boolean", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku" } } ], "requestBody": { "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemRequestModel" }, "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemRequestModel" }, "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemRequestModel" }, "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemRequestModel" }, "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Cart is created and items added. Updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "200": { "description": "Items is added to existing cart and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddPackageItemToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add item to new or existing cart", "operationId": "CartAddPackageItemToCart", "parameters": [ { "name": "cartId", "in": "query", "description": "ID of existing cart. If null, new cart will be created", "schema": { "type": "string", "description": "ID of existing cart. If null, new cart will be created", "nullable": true } }, { "name": "skuId", "in": "query", "description": "Product SKU id. (Required)", "required": true, "schema": { "type": "string", "description": "Product SKU id. (Required)" } }, { "name": "quantity", "in": "query", "description": "Quantity to add. Defaults to 1 if not provided.", "schema": { "type": "number", "description": "Quantity to add. Defaults to 1 if not provided.", "format": "decimal", "nullable": true } }, { "name": "marketId", "in": "query", "description": "Market ID for new cart - default market if null", "schema": { "type": "string", "description": "Market ID for new cart - default market if null", "nullable": true } }, { "name": "storeId", "in": "query", "description": "Store ID for new cart - defaults to null", "schema": { "type": "string", "description": "Store ID for new cart - defaults to null", "nullable": true } }, { "name": "customerId", "in": "query", "description": "CustomerId for the new cart - defaults to null", "schema": { "type": "string", "description": "CustomerId for the new cart - defaults to null", "nullable": true } }, { "name": "forceNewOrderLine", "in": "query", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku", "schema": { "type": "boolean", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku" } }, { "name": "priceStoreId", "in": "query", "description": "Only use when buying from a store with a higher unit price than the default price", "schema": { "type": "string", "description": "Only use when buying from a store with a higher unit price than the default price", "nullable": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Cart is created and item added. Updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "200": { "description": "Item is added to existing cart and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddBundleToCart": { "post": { "tags": [ "Carts | Add" ], "summary": "Add bundle to new or existing cart", "description": "If omniumProductComponents is not defined in the request, all components that are single skus, will be added as order lines.\r\nIf bundle contains products with variants, specify selected variants in components list. If you don't specify correct variant, use endpoint \"UpdateComponentsInCart\"\r\nto update the cart.\r\n

\r\nExample where one of the products in the bundle has variants. Selected variant from component will be added as order line\r\n\r\n POST /api/Cart/AddBundleToCart?skuId=BundleSkuId\r\n [\r\n {\r\n \"componentId\": \"821cdfd1-4bf1-48fe-8944-4cc51d62bc66\",\r\n \"productId\": \"castelli-33221\",\r\n \"skuId\": \"castelli-33221-M\",\r\n \"quantity\": 1\r\n }\r\n ]", "operationId": "CartAddBundleToCart", "parameters": [ { "name": "cartId", "in": "query", "description": "ID of existing cart. If null, new cart will be created", "schema": { "type": "string", "description": "ID of existing cart. If null, new cart will be created", "nullable": true } }, { "name": "skuId", "in": "query", "description": "Bundle skuId (Required)", "required": true, "schema": { "type": "string", "description": "Bundle skuId (Required)" } }, { "name": "quantity", "in": "query", "description": "Quantity to add. Defaults to 1 if not provided.", "schema": { "type": "number", "description": "Quantity to add. Defaults to 1 if not provided.", "format": "decimal", "nullable": true } }, { "name": "marketId", "in": "query", "description": "Market ID for new cart - default market if null", "schema": { "type": "string", "description": "Market ID for new cart - default market if null", "nullable": true } }, { "name": "storeId", "in": "query", "description": "Store ID for new cart - defaults to null", "schema": { "type": "string", "description": "Store ID for new cart - defaults to null", "nullable": true } }, { "name": "customerId", "in": "query", "description": "CustomerId for the new cart - defaults to null", "schema": { "type": "string", "description": "CustomerId for the new cart - defaults to null", "nullable": true } }, { "name": "forceNewOrderLine", "in": "query", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku", "schema": { "type": "boolean", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku" } }, { "name": "priceStoreId", "in": "query", "description": "Only use when buying from a store with a higher unit price than the default price", "schema": { "type": "string", "description": "Only use when buying from a store with a higher unit price than the default price", "nullable": true } } ], "requestBody": { "description": "Product components", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Cart is created and bundle added. Updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "200": { "description": "Bundle is added to existing cart and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/UpdateComponentsInCart/orderLineId/{orderLineId}": { "post": { "tags": [ "Carts | Update" ], "summary": "Update bundle components in cart", "description": "If bundle contains components/products with variants, and they are not added when bundle is added to cart, use this endpoint to update.\r\nOnly components that are not added already, will be added. If component is added as order line already, update order line insted.\r\n

\r\nExample where one of the products in the bundle has variants. Selected variant from component will be added as order line\r\n\r\n POST /api/Cart/AddBundleToCart?skuId=BundleSkuId\r\n [\r\n {\r\n \"componentId\": \"821cdfd1-4bf1-48fe-8944-4cc51d62bc66\",\r\n \"productId\": \"castelli-33221\",\r\n \"skuId\": \"castelli-33221-M\",\r\n \"quantity\": 1\r\n }\r\n ]", "operationId": "CartUpdateComponentsInCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart to update", "required": true, "schema": { "type": "string", "description": "Cart to update", "nullable": true } }, { "name": "orderLineId", "in": "path", "description": "Bundle order line id", "required": true, "schema": { "type": "string", "description": "Bundle order line id", "nullable": true } } ], "requestBody": { "description": "Components to update/add as order line", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Components to update/add as order line" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Components to update/add as order line" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Components to update/add as order line" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Components to update/add as order line" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart": { "put": { "tags": [ "Carts | Update" ], "summary": "Save cart to Omnium.", "operationId": "CartSaveCart", "requestBody": { "description": "Cart to put", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart added and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/Validate": { "post": { "tags": [ "Carts | Checkout" ], "summary": "Validate cart. Optionally specify which validators to run.", "operationId": "CartValidate", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID for the cart to validate", "required": true, "schema": { "type": "string", "description": "Cart ID for the cart to validate", "nullable": true } } ], "requestBody": { "description": "Optional: specify which validators to run. If omitted or empty, all validators are executed.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartValidationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartValidationRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart validated successfully without errors or warning", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } } } }, "422": { "description": "Validation completed with errors or warnings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } } } }, "404": { "description": "Cart was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines": { "put": { "tags": [ "Carts | Add" ], "summary": "Add order line to cart", "operationId": "CartAddOrderLineToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "forceNewOrderLine", "in": "query", "description": "", "schema": { "type": "boolean", "description": "" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returns recalculated cart with new line item", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or order line is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/Add": { "post": { "tags": [ "Carts | Add" ], "summary": "Add item to existing cart", "operationId": "CartAddItemToExistingCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. If null, new cart will be created", "required": true, "schema": { "type": "string", "description": "ID of existing cart. If null, new cart will be created", "nullable": true } }, { "name": "skuId", "in": "query", "description": "Product SKU id. (Required)", "required": true, "schema": { "type": "string", "description": "Product SKU id. (Required)" } }, { "name": "quantity", "in": "query", "description": "Quantity to add. Defaults to 1 if not provided.", "schema": { "type": "number", "description": "Quantity to add. Defaults to 1 if not provided.", "format": "decimal", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Item is added and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "422": { "description": "Item added, but validation completed with errors or warnings", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumValidationResult" } } } }, "400": { "description": "Cart ID or sku ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/SetQuantity/Sku/{skuId}/{quantity}": { "post": { "tags": [ "Carts | Line Items" ], "summary": "Update quantity on cart order line by skuId / code", "description": "This endpoint automatically detects bundle products and updates both the bundle and its components when appropriate.\r\nFor bundle products, the quantity of all component items will be recalculated based on their defined ratios.\r\nFor non-bundle products, only the individual line item quantity is updated.", "operationId": "CartUpdateCartQuantityBySku", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "skuId", "in": "path", "description": "Product SKU id. (Required)", "required": true, "schema": { "type": "string", "description": "Product SKU id. (Required)", "nullable": true } }, { "name": "quantity", "in": "path", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "required": true, "schema": { "type": "number", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "format": "decimal" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Quantity updated and cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/SetQuantity/OrderLineId/{orderLineId}/{quantity}": { "post": { "tags": [ "Carts | Line Items" ], "summary": "Update quantity on cart order line by order line ID", "description": "This endpoint automatically detects bundle products and updates both the bundle and its components when appropriate.\r\nFor bundle products, the quantity of all component items will be recalculated based on their defined ratios.\r\nFor non-bundle products, only the individual line item quantity is updated.", "operationId": "CartUpdateCartQuantityByOrderLineId", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "orderLineId", "in": "path", "description": "Order line ID. (Required)", "required": true, "schema": { "type": "string", "description": "Order line ID. (Required)", "nullable": true } }, { "name": "quantity", "in": "path", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "required": true, "schema": { "type": "number", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "format": "decimal" } }, { "name": "keepPrice", "in": "query", "description": "If false, the price will be updated to the current product price. If true, the current price will be kept, and is only recalculated with new quantity. Note: For bundle products, this parameter is ignored as bundle pricing follows specific business rules.", "schema": { "type": "boolean", "description": "If false, the price will be updated to the current product price. If true, the current price will be kept, and is only recalculated with new quantity. Note: For bundle products, this parameter is ignored as bundle pricing follows specific business rules." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Quantity updated and cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart or order line was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/SetSelectedUnitQuantity/Sku/{skuId}/{selectedUnit}/{selectedUnitQuantity}": { "post": { "tags": [ "Carts | Line Items" ], "summary": "Update selected unit quantity on cart order line by skuId / code", "operationId": "CartUpdateCartSelectedUnitQuantityBySku", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "skuId", "in": "path", "description": "Product SKU id. (Required)", "required": true, "schema": { "type": "string", "description": "Product SKU id. (Required)", "nullable": true } }, { "name": "selectedUnit", "in": "path", "description": "Selected unit of measure (Required)", "required": true, "schema": { "type": "string", "description": "Selected unit of measure (Required)", "nullable": true } }, { "name": "selectedUnitQuantity", "in": "path", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "required": true, "schema": { "type": "number", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "format": "decimal" } }, { "name": "selectedUnitConversionFactor", "in": "query", "description": "Conversion factor between selected unit of measure and default UOM (Default is 1:1)", "schema": { "type": "number", "description": "Conversion factor between selected unit of measure and default UOM (Default is 1:1)", "format": "decimal", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Unit quantity updated and cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/SetSelectedUnitQuantity/OrderLineId/{orderLineId}/{selectedUnit}/{selectedUnitQuantity}": { "post": { "tags": [ "Carts | Line Items" ], "summary": "Update selected unit quantity on cart order line by order line ID", "operationId": "CartUpdateCartSelectedUnitQuantityByOrderLineId", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "orderLineId", "in": "path", "description": "Order line ID. (Required)", "required": true, "schema": { "type": "string", "description": "Order line ID. (Required)", "nullable": true } }, { "name": "selectedUnit", "in": "path", "description": "Selected unit of measure (Required)", "required": true, "schema": { "type": "string", "description": "Selected unit of measure (Required)", "nullable": true } }, { "name": "selectedUnitQuantity", "in": "path", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "required": true, "schema": { "type": "number", "description": "Quantity to set. Defaults to 0 if less than 0. (Required)", "format": "decimal" } }, { "name": "selectedUnitConversionFactor", "in": "query", "description": "Conversion factor between selected unit of measure and default UOM (Default is 1:1)", "schema": { "type": "number", "description": "Conversion factor between selected unit of measure and default UOM (Default is 1:1)", "format": "decimal", "nullable": true } }, { "name": "keepPrice", "in": "query", "description": "If false, the price will be updated to the current product price. If true, the current price will be kept, and is only recalculated with new quantity.", "schema": { "type": "boolean", "description": "If false, the price will be updated to the current product price. If true, the current price will be kept, and is only recalculated with new quantity." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Unit quantity updated and cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart or order line was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/OrderLines/{lineItemId}": { "delete": { "tags": [ "Carts | Line Items" ], "summary": "Delete item from cart", "operationId": "CartDeleteLineItem", "parameters": [ { "name": "lineItemId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "deleteComponents", "in": "query", "description": "If the order line you're deleting is a package or bundle, set deleteComponents to true if you want to remove its components from the cart as well", "schema": { "type": "boolean", "description": "If the order line you're deleting is a package or bundle, set deleteComponents to true if you want to remove its components from the cart as well", "default": false } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Item is deleted and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or order line is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddCustomer/{customerId}": { "put": { "tags": [ "Carts | Add" ], "summary": "Add customer ID to existing cart", "operationId": "CartAddCustomerIdToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "customerId", "in": "path", "description": "Customer ID to add to cart. (Required)", "required": true, "schema": { "type": "string", "description": "Customer ID to add to cart. (Required)", "nullable": true } }, { "name": "enrichCart", "in": "query", "description": "If true, the customer name and contact info is added to cart", "schema": { "type": "boolean", "description": "If true, the customer name and contact info is added to cart" } }, { "name": "isPriceRecalculated", "in": "query", "description": "If true, prices will be recalculated based on customer ID. If false, prices will remain the same.", "schema": { "type": "boolean", "description": "If true, prices will be recalculated based on customer ID. If false, prices will remain the same." } }, { "name": "customerSpecificPrices", "in": "query", "description": "If true, customer specific prices customer specific prices will replaces the current prices. If there is no customer specific prices, the default price will be used instead.", "schema": { "type": "boolean", "description": "If true, customer specific prices customer specific prices will replaces the current prices. If there is no customer specific prices, the default price will be used instead." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer is added to cart, and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or customer ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RemoveCustomerFromCart": { "put": { "tags": [ "Carts | Update" ], "summary": "Removes a customer from cart. This will remove all customer related info like id, phone, e-mail and address.\r\nPrices will also be recalculated", "operationId": "CartRemoveCustomerFromCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart (Required)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer is removed from cart, and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RecalculatePrices": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Recalculate prices", "operationId": "CartRecalculatePrices", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "schema": { "type": "string", "description": "Cart ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart with recalculated prices", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "404": { "description": "Cart was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Cart/{cartId}/AddPayments": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Add payments to existing cart", "description": "Register payment transaction(s) from your payment provider on the cart.\r\n \r\nThe transactionId is typically provided by the payment provider and is often a GUID.\r\nThis ID ties together related transactions - the same transactionId is for instance used for\r\nauthorization, capture, and credit operations on the same payment.\r\n \r\nFor e-commerce orders: Use transactionType \"Authorization\" - Omnium workflows handle Capture/Credit/Void automatically.\r\n \r\nFor POS: Use transactionType \"Sale\" since payment is captured immediately.\r\n \r\nExample - E-commerce payment (Klarna):\r\n \r\n PUT /api/carts/{cartId}/AddPayments\r\n [\r\n {\r\n \"amount\": 999.00,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"transactionId\": \"klarna-order-abc123\",\r\n \"transactionType\": \"Authorization\",\r\n \"status\": \"Processed\"\r\n }\r\n ]\r\n \r\nExample - POS sale:\r\n \r\n PUT /api/carts/{cartId}/AddPayments\r\n [\r\n {\r\n \"amount\": 599.00,\r\n \"paymentMethodName\": \"Card\",\r\n \"transactionId\": \"terminal-tx-12345\",\r\n \"transactionType\": \"Sale\",\r\n \"status\": \"Processed\"\r\n }\r\n ]\r\n \r\nExample - Split payment (Gift card + Vipps):\r\n \r\n PUT /api/carts/{cartId}/AddPayments\r\n [\r\n {\r\n \"amount\": 200.00,\r\n \"paymentMethodName\": \"GiftCard\",\r\n \"transactionId\": \"GC-ABC123\",\r\n \"transactionType\": \"Authorization\",\r\n \"status\": \"Processed\"\r\n },\r\n {\r\n \"amount\": 799.00,\r\n \"paymentMethodName\": \"Vipps\",\r\n \"transactionId\": \"vipps-order-xyz\",\r\n \"transactionType\": \"Authorization\",\r\n \"status\": \"Processed\"\r\n }\r\n ]", "operationId": "CartAddPaymentToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } }, { "name": "overwriteExisting", "in": "query", "description": "Indicates whether to overwrite existing payments. Defaults to true. If true, replaces existing payments. If false, appends new payments", "schema": { "type": "boolean", "description": "Indicates whether to overwrite existing payments. Defaults to true. If true, replaces existing payments. If false, appends new payments", "default": true } } ], "requestBody": { "description": "List of payments to add to cart", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "List of payments to add to cart", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "List of payments to add to cart", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "List of payments to add to cart", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "List of payments to add to cart", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Payments are added, and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or payments are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RemovePayments": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Remove payments from existing cart", "operationId": "CartRemovePaymentsFromCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentFilters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentFilters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentFilters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentFilters" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Payments are added, and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or payments are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddShipments": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Add shipments to existing cart", "description": "Add shipping information to the cart. The shippingMethodName must match a configured shipping method in Omnium.\r\n \r\nThe shipmentId should always be set - it can be a simple value like \"1\" or a GUID.\r\nIt is used to reference the shipment for updates, deletions, and order workflows.\r\n \r\nExample - Standard home delivery:\r\nThe warehouseCode should be the storeId of the store in Omnium that will send the shipment.\r\n \r\n PUT /api/carts/{cartId}/AddShipments\r\n [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"Bring_SERVICEPAKKE\",\r\n \"warehouseCode\": \"central-warehouse-oslo-01\"\r\n }\r\n ]\r\n \r\nExample - Click and collect (pickup in store):\r\nThe pickUpWarehouseCode is the storeId of the store where the customer will pick up the order.\r\nThis is only needed if it differs from the sender (warehouseCode), which is often not the case.\r\n \r\n PUT /api/carts/{cartId}/AddShipments\r\n [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"ClickAndCollect\",\r\n \"warehouseCode\": \"central-warehouse-oslo-01\"\r\n \"pickUpWarehouseCode\": \"STORE-OSLO-01\"\r\n }\r\n ]\r\n \r\nExample - Shipment with free shipping discount:\r\n \r\n PUT /api/carts/{cartId}/AddShipments\r\n [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"PostNord_MyPack\",\r\n \"warehouseCode\": \"central-warehouse-oslo-01\"\r\n \"discounts\": [\r\n {\r\n \"discountType\": \"Shipping\",\r\n \"discountName\": \"Free shipping\",\r\n \"discountValue\": 100,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n ]\r\n }\r\n ]", "operationId": "CartAddShipmentsToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } } ], "requestBody": { "description": "List of shipments to add to cart", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "List of shipments to add to cart", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "List of shipments to add to cart", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "List of shipments to add to cart", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "List of shipments to add to cart", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Shipments are added, and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Cart ID or shipments are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddStore/{storeId}": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Add store to cart", "operationId": "CartAddStoreToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "storeId", "in": "path", "description": "Store selling the products", "required": true, "schema": { "type": "string", "description": "Store selling the products", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Store or cart not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddCouponCode/{couponCode}": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Adding coupon code to cart and recalculates discounts", "operationId": "CartAddCouponCodeToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "couponCode", "in": "path", "description": "Coupon code to add", "required": true, "schema": { "type": "string", "description": "Coupon code to add", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/ApplyVoucher/{voucherId}": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Applying voucher to cart - A payment with the corresponding value will be added to the cart.", "operationId": "CartApplyVoucher", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "voucherId", "in": "path", "description": "Id of voucher to apply", "required": true, "schema": { "type": "string", "description": "Id of voucher to apply", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RemoveVoucherFromCart/{voucherId}": { "post": { "tags": [ "Carts | Checkout" ], "summary": "Removing a voucher from the cart making the voucher available for use again.", "operationId": "CartRemoveVoucherFromCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "voucherId", "in": "path", "description": "Id of voucher to remove", "required": true, "schema": { "type": "string", "description": "Id of voucher to remove", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddPersonalDiscountCoupon/{couponId}": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Adding personal discount coupon to cart by unique coupon Id and recalculates discounts", "operationId": "CartAddPersonalDiscountCouponToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "couponId", "in": "path", "description": "Coupon code to add", "required": true, "schema": { "type": "string", "description": "Coupon code to add", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RemoveCouponCode/{couponCode}": { "delete": { "tags": [ "Carts | Checkout" ], "summary": "Removes coupon code from cart and recalculates discounts", "operationId": "CartRemoveCouponCodeFromCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "couponCode", "in": "path", "description": "Coupon code to remove", "required": true, "schema": { "type": "string", "description": "Coupon code to remove", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddGiftCard/{giftCardCode}": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Add gift card payment to cart", "operationId": "CartAddGiftCardToCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "giftCardCode", "in": "path", "description": "Gift card code to use for payment", "required": true, "schema": { "type": "string", "description": "Gift card code to use for payment", "nullable": true } }, { "name": "giftCardPin", "in": "query", "description": "Gift card PIN, if required, along with the code provided by the gift card provider.", "schema": { "type": "string", "description": "Gift card PIN, if required, along with the code provided by the gift card provider.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/RemoveGiftCard/{giftCardCode}": { "delete": { "tags": [ "Carts | Checkout" ], "summary": "Remove gift card payment from cart", "operationId": "CartRemoveGiftCardFromCart", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID to update", "required": true, "schema": { "type": "string", "description": "Cart ID to update", "nullable": true } }, { "name": "giftCardCode", "in": "path", "description": "Gift card code to remove", "required": true, "schema": { "type": "string", "description": "Gift card code to remove", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/Search": { "post": { "tags": [ "Carts | Search" ], "summary": "Search carts", "operationId": "CartSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning items found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } } } }, "400": { "description": "Search request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/ScrollSearch": { "post": { "tags": [ "Carts | Search" ], "summary": "Scroll carts by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.", "operationId": "CartScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning products", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/Scroll/{id}": { "get": { "tags": [ "Carts | Search" ], "summary": "Scroll carts is used to get a large amount of carts.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "CartScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumResult" } } } } } } }, "/api/Cart/CreateOrderFromCart/{cartId}": { "post": { "tags": [ "Obsolete" ], "summary": "Create order from cart. Use POST /api/carts/{cartId}/Checkout instead.", "operationId": "CartCreateOrderFromCartId", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "orderType", "in": "query", "description": "Order type to create (Pos, Online, ClickAndCollect, etc)", "schema": { "type": "string", "description": "Order type to create (Pos, Online, ClickAndCollect, etc)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning order", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "deprecated": true } }, "/api/Cart/{cartId}/Checkout": { "post": { "tags": [ "Carts | Checkout" ], "summary": "Checkout: convert cart to order with optional selective validation.\r\nOptionally applies a cart patch (which can attach payments / shipments) in the same call.", "description": "Converts a cart to an order in a single call. You can optionally patch the cart - including attaching\r\npayments and shipments via the patch - avoiding the need for separate PatchCart / AddPayments / AddShipments\r\nrequests beforehand.\r\n \r\nThe cart is never persisted by this operation: mutations are applied in-memory only and consumed by the order creation.\r\nOn validation failure the cart in storage is untouched.\r\n \r\n**Patching payments and shipments**: use {cartPatch.orderForm.paymentsMergeMode} and\r\n{cartPatch.orderForm.shipmentsMergeMode} to control list behaviour:\r\n{UpdateOnly} (default) - match existing by ID; unknown IDs counted in NotFoundCount.{AddOrUpdate} - match existing by ID; unknown IDs appended as new.{Replace} - wipe existing list; use the supplied list wholesale.{cartPatch.orderForm.discounts} and {cartPatch.orderForm.couponCodes} support the same merge modes via\r\n{discountsMergeMode} and {couponCodesMergeMode} (discounts default to {AddOrUpdate}; coupon codes\r\ndefault to legacy replace-when-non-empty).\r\n \r\nExample - Minimal checkout (all defaults, no body required):\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n \r\nExample - Checkout with a consumer-specified order ID and order type:\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"orderId\": \"PO-2026-000123\",\r\n \"cartPatch\": { \"orderType\": \"ClickAndCollect\" }\r\n }\r\n \r\nExample - Checkout adding a new payment and a new shipment via patch (common case):\r\n{paymentsMergeMode} and {shipmentsMergeMode} are set to {AddOrUpdate} so the new items\r\nare appended to the cart's existing lists (if any).\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"cartPatch\": {\r\n \"orderForm\": {\r\n \"paymentsMergeMode\": \"AddOrUpdate\",\r\n \"payments\": [\r\n {\r\n \"amount\": 499.00,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"klarna-txn-abc123\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipmentsMergeMode\": \"AddOrUpdate\",\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"Bring_SERVICEPAKKE\",\r\n \"warehouseCode\": \"central-warehouse-oslo-01\"\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n \r\nExample - Checkout that replaces the cart's payments and shipments wholesale:\r\n{paymentsMergeMode} and {shipmentsMergeMode} are set to {Replace} so any existing\r\nentries on the cart are discarded and the supplied lists take their place.\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"cartPatch\": {\r\n \"orderForm\": {\r\n \"paymentsMergeMode\": \"Replace\",\r\n \"payments\": [\r\n {\r\n \"amount\": 499.00,\r\n \"paymentMethodName\": \"Vipps\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"vipps-txn-xyz789\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipmentsMergeMode\": \"Replace\",\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"Bring_SERVICEPAKKE\",\r\n \"warehouseCode\": \"central-warehouse-oslo-01\"\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n \r\nExample - Checkout with customer data patched and a new payment, all in one call:\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"cartPatch\": {\r\n \"customerEmail\": \"ola.nordmann@example.com\",\r\n \"customerPhone\": \"+4790000000\",\r\n \"billingAddress\": {\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"postalCode\": \"0159\",\r\n \"city\": \"Oslo\",\r\n \"countryCode\": \"NO\"\r\n },\r\n \"properties\": [\r\n { \"keyGroup\": \"checkout\", \"key\": \"consentId\", \"value\": \"c-12345\" }\r\n ],\r\n \"orderForm\": {\r\n \"paymentsMergeMode\": \"AddOrUpdate\",\r\n \"payments\": [\r\n {\r\n \"amount\": 499.00,\r\n \"paymentMethodName\": \"Vipps\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"vipps-txn-final\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n \r\nValidator selection via {validators}:\r\nOmitted or {null} - all configured validators are executed.Empty array {[]} - no validators are run (the consumer has opted out of validation).Non-empty array - only the named validators are run.\r\nUse GET {/api/carts/Validators} to discover the available validator names for the current tenant.\r\n \r\nExample - Checkout running only selected validators:\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"validators\": [\"StockValidator\", \"PriceValidator\"],\r\n }\r\n \r\nExample - Checkout skipping all validation (consumer opts out):\r\n \r\n POST /api/carts/{cartId}/Checkout\r\n {\r\n \"validators\": [],\r\n }", "operationId": "CartCheckout", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "schema": { "type": "string", "description": "Cart ID", "nullable": true } } ], "requestBody": { "description": "Checkout request with optional cart patch, validator selection and order ID", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Checkout succeeded. Result contains the created order and any validation warnings.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } } } }, "400": { "description": "Order creation already in progress for this cart.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart does not exist, or required market could not be resolved.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "422": { "description": "Validation failed or cart patch produced errors. Result contains validation details.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCheckoutResult" } } } }, "500": { "description": "Unexpected error during checkout.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/Validators": { "get": { "tags": [ "Carts | Checkout" ], "summary": "Get available cart validators for the current tenant.\r\nReturns the names of validators that can be used in the Validate and Checkout endpoints.", "operationId": "CartGetValidators", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "List of available validator names", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/Cart/{id}/GetShippingOptions": { "get": { "tags": [ "Carts | Checkout" ], "summary": "Get valid shipping options for a cart.", "description": "Based on consignee/receivers postalCode and cart market, this will return valid shipping options with price", "operationId": "CartGetShippingOptions", "parameters": [ { "name": "id", "in": "path", "description": "Cart id", "required": true, "schema": { "type": "string", "description": "Cart id", "nullable": true } }, { "name": "postalCode", "in": "query", "description": "Consignee/receivers postalCode", "schema": { "type": "string", "description": "Consignee/receivers postalCode", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "A list of shippingOptions", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart or shipment options not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/GetShippingOptionsByZipCode": { "get": { "tags": [ "Carts | Checkout" ], "summary": "Get valid shipping options for a zip/postal code.", "description": "Based on consignee/receivers postalCode market, this will return valid shipping options with price\r\nThis will not calculate promotion discounts or price from Shipping provider. Then you should use GetShippingOptions\r\nThis endpoint can be used if Omnium does not have the cart, but you want to get configured shipping options", "operationId": "CartGetShippingOptionsByZipCode", "parameters": [ { "name": "marketId", "in": "query", "description": "market id", "schema": { "type": "string", "description": "market id", "nullable": true } }, { "name": "postalCode", "in": "query", "description": "Consignee/receivers postalCode", "schema": { "type": "string", "description": "Consignee/receivers postalCode", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "A list of shippingOptions", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingOption" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart or shipment options not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{id}/GetPaymentOptions": { "get": { "tags": [ "Carts | Checkout" ], "summary": "Get valid payment options for a cart.", "description": "Based on cart market, this will return valid payment options. If cart has storeId we will also filter on store", "operationId": "CartGetPaymentOptions", "parameters": [ { "name": "id", "in": "path", "description": "Cart id", "required": true, "schema": { "type": "string", "description": "Cart id", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "A list of payment options", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart or payment options not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/GetCartsByCustomer": { "get": { "tags": [ "Carts | Get" ], "summary": "Get carts by customer ID", "operationId": "CartGetCartsByCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Carts for customer is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/GetCarts": { "get": { "tags": [ "Carts | Get" ], "summary": "Returns a list of carts, support paging", "operationId": "CartGetCarts", "parameters": [ { "name": "storeIds", "in": "query", "description": "List of store IDs", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of store IDs", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Filter on changed date(UTC)", "schema": { "type": "string", "description": "Filter on changed date(UTC)", "format": "date-time" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.(default is 20)", "schema": { "type": "integer", "description": "Max 100. Minimum 1.(default is 20)", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Carts is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/AddDiscount": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Add discount to cart", "description": "Add a discount to the cart. Use discountType to specify whether it applies to the order, specific line items, or other scenarios.\r\n \r\nNote: Discounts are usually applied automatically to a cart - either by Omnium's promotions engine when adding items,\r\nwhen adding a coupon code, or when adding a customer to the cart and items are recalculated.\r\nIf you are unsure whether you should use this endpoint or not, you probably shouldn't😵‍💫\r\n \r\nExample - 20% order-level discount:\r\n \r\n PUT /api/carts/{cartId}/AddDiscount\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"Summer sale 20%\",\r\n \"discountValue\": 20,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n \r\nExample - Fixed amount discount (100 NOK off):\r\n \r\n PUT /api/carts/{cartId}/AddDiscount\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"100 NOK rabatt\",\r\n \"discountValue\": 100,\r\n \"rewardType\": \"Money\"\r\n }\r\n \r\nExample - Line item discount on specific SKUs:\r\n \r\n PUT /api/carts/{cartId}/AddDiscount\r\n {\r\n \"discountType\": \"LineItem\",\r\n \"discountName\": \"50% on selected items\",\r\n \"discountValue\": 50,\r\n \"rewardType\": \"Percentage\",\r\n \"skuIds\": [\"SKU-001\", \"SKU-002\"]\r\n }\r\n \r\nExample - 3 for 2 promotion:\r\n \r\n PUT /api/carts/{cartId}/AddDiscount\r\n {\r\n \"discountType\": \"LineItem\",\r\n \"discountName\": \"3 for 2\",\r\n \"rewardType\": \"MultiBuys\",\r\n \"skuIds\": [\"SKU-001\", \"SKU-002\", \"SKU-003\"],\r\n \"promotionMultiBuyReward\": {\r\n \"requiredBuyAmount\": 2,\r\n \"numberOfDiscountedItems\": 1,\r\n \"percentage\": 100\r\n }\r\n }", "operationId": "CartAddDiscount", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "schema": { "type": "string", "description": "Cart ID", "nullable": true } } ], "requestBody": { "description": "Discount to add to cart", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDiscount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDiscount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDiscount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDiscount" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Discount added and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/PatchCart": { "patch": { "tags": [ "Carts | Update" ], "summary": "Patch cart - update only values in request", "description": "Only the properties supplied in the body are updated; everything else on the cart is left untouched.\r\nThe cart is recalculated after the patch is applied.\r\n \r\nExample - update the customer email and add a custom property:\r\n \r\n PATCH /api/carts/{cartId}/PatchCart\r\n {\r\n \"customerEmail\": \"ola.nordmann@example.com\",\r\n \"properties\": [\r\n { \"key\": \"giftWrap\", \"value\": \"true\" }\r\n ]\r\n }\r\n \r\nList properties such as {orderForm.payments}, {orderForm.shipments}, {orderForm.discounts} and\r\n{orderForm.couponCodes} can be merged with add/update/replace semantics - see the corresponding\r\n{*MergeMode} fields for details.", "operationId": "CartPatchCart", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart. (Required)", "nullable": true } } ], "requestBody": { "description": "Cart patches. Properties with value will be updated", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart updated successfully" }, "400": { "description": "Cart patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/UpdateDiscounts": { "put": { "tags": [ "Carts | Checkout" ], "summary": "Replacing discounts on cart", "operationId": "CartUpdateDiscounts", "parameters": [ { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "schema": { "type": "string", "description": "Cart ID", "nullable": true } } ], "requestBody": { "description": "List of discounts to place on cart", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "List of discounts to place on cart", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "List of discounts to place on cart", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "List of discounts to place on cart", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "List of discounts to place on cart", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Discount updated and cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/DeactivateCart": { "post": { "tags": [ "Carts | Update" ], "summary": "Deactivate cart", "operationId": "CartDeactivateCart", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Cart deactivated and updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/GetAsPdf/{cartId}": { "get": { "tags": [ "Carts | Other" ], "summary": "Get cart as PDF", "operationId": "CartGetAsPdf", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of existing cart (required)", "required": true, "schema": { "type": "string", "description": "ID of existing cart (required)", "nullable": true } }, { "name": "templateReference", "in": "query", "description": "Template reference including full path and extension (ex \"Folder/CustomOffer.json\" )", "schema": { "type": "string", "description": "Template reference including full path and extension (ex \"Folder/CustomOffer.json\" )", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "application/pdf": { "schema": { "type": "file" } }, "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Order was not found", "content": { "application/pdf": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/pdf": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/{cartId}/PackageBreakdown": { "post": { "tags": [ "Carts | Other" ], "summary": "Break down packages or bundle in cart. All components will be added as separate order lines.", "operationId": "CartPackageBreakdown", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated cart is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/AddComment": { "post": { "tags": [ "Carts | Other" ], "summary": "Add a comment to a cart, with the option to send SMS, email or both", "description": "Sample request for adding a public comment with email notification:\r\n \r\n POST /api/Cart/AddComment\r\n {\r\n \"CartId\": \"CART-12345\",\r\n \"CommentType\": \"Public\",\r\n \"CommentText\": \"Hi! This is just a sample text. Fun fact: Bananas are technically berries, but strawberries are not.\",\r\n \"SendEmail\": true,\r\n \"EmailSubject\": \"Something cart related\",\r\n \"EmailTo\": \"customer@example.com\",\r\n \"EmailFrom\": \"carts@yourcompany.com\",\r\n \"SenderName\": \"Cartman\"\r\n }\r\n \r\nSample request for adding a public comment with SMS notification:\r\n \r\n POST /api/Cart/AddComment\r\n {\r\n \"CartId\": \"CART-12345\",\r\n \"CommentType\": \"Public\",\r\n \"CommentText\": \"Hi there! This is an SMS message for you😎\",\r\n \"SendSms\": true,\r\n \"SmsPhoneNumber\": \"+4712345678\"\r\n }\r\n \r\nSample request for adding an internal comment (staff only):\r\n \r\n POST /api/Cart/AddComment\r\n {\r\n \"CartId\": \"CART-12345\",\r\n \"CommentType\": \"Internal\",\r\n \"CommentText\": \"Customer called about cart contents.\",\r\n \"CreatedBy\": \"Support Team\"\r\n }\r\n \r\nNotes:\r\n- CommentType defaults to \"Public\" if not specified. CreatedBy defaults to the current API user's username if not specified.\r\n- EmailTo, EmailFrom, SenderName, and SmsPhoneNumber will fall back to the store's (or global) default settings in Omnium if not specified.\r\n- EmailTo falls back to the cart's customer email. SmsPhoneNumber falls back to the cart's customer phone.", "operationId": "CartAddComment", "requestBody": { "description": "The comment request containing cart ID, comment type, text, and notification settings", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartCommentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartCommentRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Comment added successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Cart not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cart/ExportCarts": { "post": { "tags": [ "Carts | Update" ], "summary": "Export carts to a connector", "description": "Sample request for exporting carts to a connector:\r\n \r\n POST /api/Cart/ExportCarts\r\n {\r\n \"connectorId\": \"19527b9b-6ebf-4d34-8e32-28ff618ff168\",\r\n \"cartIds\": [\"CART-001\", \"CART-002\"]\r\n }\r\n \r\n POST /api/Cart/ExportCarts\r\n {\r\n \"connectorName\": \"sitoo\",\r\n \"cartIds\": [\"CART-001\"]\r\n }\r\n \r\nIf both connectorId and connectorName are provided, connectorId takes priority as it is more specific.", "operationId": "CartExportCarts", "requestBody": { "description": "The export request containing connector ID or name and list of cart IDs to export", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartExportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartExportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartExportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartExportRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Carts exported successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error occurred during export", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/CartTemplate/{id}": { "get": { "tags": [ "Carts | Templates" ], "summary": "Get cart template", "operationId": "CartTemplateGetCartTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } } } } } } }, "/api/CartTemplate": { "put": { "tags": [ "Carts | Templates" ], "summary": "Add or update cart template", "description": "Add or update cart template", "operationId": "CartTemplateUpdateCartTemplate", "requestBody": { "description": "Cart template", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } } } } } }, "delete": { "tags": [ "Carts | Templates" ], "summary": "Delete cart template", "description": "Search cart templates", "operationId": "CartTemplateDeleteCartTemplate", "parameters": [ { "name": "cartTemplateId", "in": "query", "description": "The ID of the cart template", "schema": { "type": "string", "description": "The ID of the cart template", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/CartTemplate/Search": { "post": { "tags": [ "Carts | Templates" ], "summary": "Search cart template orders", "description": "Search cart templates", "operationId": "CartTemplateSearch", "requestBody": { "description": "Search request object for cart templates", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateSearchRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateSearchRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateSearchRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateSearchRequestModel" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/CartTemplate/CreateCartFromTemplate": { "post": { "tags": [ "Carts | Templates" ], "summary": "Create cart from template", "description": "Create cart from template", "operationId": "CartTemplateCreateCartFromTemplate", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateCreateCartRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateCreateCartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateCreateCartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplateCreateCartRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCartTemplate" } } } } } } }, "/api/Cases/{id}": { "get": { "tags": [ "Cases" ], "summary": "Get single case by ID", "operationId": "CasesGet", "parameters": [ { "name": "id", "in": "path", "description": "Case ID", "required": true, "schema": { "type": "string", "description": "Case ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Case ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Case does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Cases" ], "summary": "Delete a case", "operationId": "CasesDelete", "parameters": [ { "name": "id", "in": "path", "description": "Case ID", "required": true, "schema": { "type": "string", "description": "Case ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case deleted" }, "400": { "description": "Case ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cases": { "post": { "tags": [ "Cases" ], "summary": "Create a new case", "operationId": "CasesPost", "requestBody": { "description": "Case to create", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case created and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Invalid case data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Cases" ], "summary": "Full update of an existing case", "operationId": "CasesPut", "requestBody": { "description": "Case with updated values", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case updated and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Invalid case data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Case not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Cases" ], "summary": "Partial update of an existing case. Only non-null values will be applied.", "operationId": "CasesPatch", "requestBody": { "description": "Patch with values to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCasePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCasePatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCasePatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCasePatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case patched and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Invalid patch data", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Case not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cases/Search": { "post": { "tags": [ "Cases" ], "summary": "Search for cases", "operationId": "CasesSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCaseSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCaseSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCaseSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCaseSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search results returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCaseOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCaseOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCaseOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cases/{id}/AssignTo": { "post": { "tags": [ "Cases" ], "summary": "Assign a case to a user", "operationId": "CasesAssignTo", "parameters": [ { "name": "id", "in": "path", "description": "Case ID", "required": true, "schema": { "type": "string", "description": "Case ID", "nullable": true } }, { "name": "userId", "in": "query", "description": "User ID to assign to", "schema": { "type": "string", "description": "User ID to assign to", "nullable": true } }, { "name": "userName", "in": "query", "description": "Display name of the user", "schema": { "type": "string", "description": "Display name of the user", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case assigned and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Invalid parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Case not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Cases/{id}/ChangeStatus": { "post": { "tags": [ "Cases" ], "summary": "Change the status of a case", "operationId": "CasesChangeStatus", "parameters": [ { "name": "id", "in": "path", "description": "Case ID", "required": true, "schema": { "type": "string", "description": "Case ID", "nullable": true } }, { "name": "status", "in": "query", "description": "New status", "schema": { "type": "string", "description": "New status", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Case status changed and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCase" } } } }, "400": { "description": "Invalid parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Case not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ClickAndCollect/GetOrdersForCustomer": { "get": { "tags": [ "Orders | Click and Collect" ], "summary": "Get Click and Collect orders for customer. Support paging", "operationId": "ClickAndCollectGetOrdersForCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "Customer ID", "schema": { "type": "string", "description": "Customer ID", "nullable": true } }, { "name": "phone", "in": "query", "description": "Phone number", "schema": { "type": "string", "description": "Phone number", "nullable": true } }, { "name": "email", "in": "query", "description": "E-mail address", "schema": { "type": "string", "description": "E-mail address", "nullable": true } }, { "name": "storeId", "in": "query", "description": "Store ID", "schema": { "type": "array", "items": { "type": "string" }, "description": "Store ID", "nullable": true } }, { "name": "page", "in": "query", "description": "Page number. Minimum 1. Defaults to 1", "schema": { "type": "integer", "description": "Page number. Minimum 1. Defaults to 1", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Defaults to 20", "schema": { "type": "integer", "description": "Max 100. Defaults to 20", "format": "int32" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error" }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } } } } }, "/api/ClickAndCollect/GetOrderForCustomer": { "get": { "tags": [ "Orders | Click and Collect" ], "summary": "Get a click and collect order for a single customers", "operationId": "ClickAndCollectGetOrderForCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "The id of the customer", "schema": { "type": "string", "description": "The id of the customer", "nullable": true } }, { "name": "orderId", "in": "query", "description": "The id of the order", "schema": { "type": "string", "description": "The id of the order", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error" }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } } } } }, "/api/ClickAndCollect/ExtendCustomerPickupDeadline": { "post": { "tags": [ "Orders | Click and Collect" ], "summary": "Extend the customer pickup deadline for a click and collect order", "operationId": "ClickAndCollectExtendCustomerPickupDeadline", "parameters": [ { "name": "orderId", "in": "query", "description": "The id of the order", "required": true, "schema": { "type": "string", "description": "The id of the order" } }, { "name": "extendedPickupTime", "in": "query", "description": "TimeSpan for which the customerPickupDeadline will be extended", "required": true, "schema": { "type": "string", "description": "TimeSpan for which the customerPickupDeadline will be extended", "example": "00:00:00" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Server Error" }, "200": { "description": "Success" } } } }, "/api/Comments/{commentId}": { "get": { "tags": [ "Comments" ], "summary": "Get comment.", "description": "Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.", "operationId": "CommentsGet", "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "404": { "description": "Not Found" } } } }, "/api/Comments/Search": { "post": { "tags": [ "Comments" ], "summary": "Search comments.", "description": "Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.", "operationId": "CommentsSearch", "requestBody": { "description": "Search request object for comments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCommentSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCommentSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCommentSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCommentSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Comments/Add": { "put": { "tags": [ "Comments" ], "summary": "Add/update comment. Can send out notification in the process.", "description": "Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.", "operationId": "CommentsAdd", "requestBody": { "description": "Omnium Comment object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "400": { "description": "Bad Request" } } } }, "/api/Comments/Update": { "patch": { "tags": [ "Comments" ], "summary": "Update selected fields in a comment - no support for sending notification in this endpoint.", "description": "Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.", "operationId": "CommentsUpdate", "requestBody": { "description": "Customer comment to patch", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCommentPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCommentPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCommentPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCommentPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Comment patched", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Comment not found" } } } }, "/api/Comments/{id}": { "delete": { "tags": [ "Comments" ], "summary": "Delete comment.", "description": "Only used for Project comments at the moment. For comments related to other objects comments should be managed on the objects themselves or through dedicated endpoints.", "operationId": "CommentsDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Comment deleted" }, "404": { "description": "Comment not found" } } } }, "/api/CostPrices/AddMany": { "put": { "tags": [ "Products | Cost Prices" ], "summary": "", "operationId": "CostPricesPutCostPrices", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceUpdateRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceUpdateRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceUpdateRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceUpdateRequest" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/CostPrices/Search": { "post": { "tags": [ "Products | Cost Prices" ], "operationId": "CostPricesSearch", "requestBody": { "description": "The CostPriceSearchRequest contains properties for filtering cost prices", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCostPriceSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCostPriceSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCostPriceSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCostPriceSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning cost prices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCostPriceOmniumResult" } } } }, "400": { "description": "Search request invalid", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/CostPrices": { "delete": { "tags": [ "Products | Cost Prices" ], "summary": "Delete one or more cost prices on a product in Omnium. Will delete existing cost price if found.", "operationId": "CostPricesDeleteCostPrices", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceDeleteRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceDeleteRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceDeleteRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPriceDeleteRequest" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" } } } }, "/api/CustomerGroups/{customerGroupId}": { "get": { "tags": [ "Customers | Customer groups" ], "summary": "Get a customer group", "operationId": "CustomerGroupsGetCustomerGroup", "parameters": [ { "name": "customerGroupId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } } } } } } }, "/api/CustomerGroups/CustomerGroups/Search": { "post": { "tags": [ "Customers | Customer groups" ], "summary": "Search customer groups logs", "description": "Search customer groups.", "operationId": "CustomerGroupsSearch", "requestBody": { "description": "Search request object for customer groups", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroupOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/CustomerGroups/CustomerGroups/Add": { "put": { "tags": [ "Customers | Customer groups" ], "summary": "Add/update customer group", "description": "Add/update a customer group.", "operationId": "CustomerGroupsAdd", "requestBody": { "description": "Omnium CustomerGroup object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerGroup" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/CustomerGroups/CustomerGroups/{id}": { "delete": { "tags": [ "Customers | Customer groups" ], "summary": "Delete customer group", "operationId": "CustomerGroupsDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer group deleted" }, "404": { "description": "Customer group not found" } } } }, "/api/CustomerPrivacy/ChangePrivateCustomerId": { "get": { "tags": [ "Customers | B2C | Privacy" ], "summary": "Change private customer id, and all data assosiated with that id over to new customer object.", "operationId": "CustomerPrivacyChangePrivateCustomerId", "parameters": [ { "name": "fromCustomerId", "in": "query", "description": "Move data from this customer. Customer with this id will also be deleted!", "required": true, "schema": { "type": "string", "description": "Move data from this customer. Customer with this id will also be deleted!" } }, { "name": "toCustomerId", "in": "query", "description": "Move data to this customer. Created if not exist.", "required": true, "schema": { "type": "string", "description": "Move data to this customer. Created if not exist." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/CustomerPrivacy/ChangePrivateCustomerIdBatch": { "post": { "tags": [ "Customers | B2C | Privacy" ], "summary": "Batch change private customer id, and all data assosiated with that id over to new customer object\r\nMax size in batch is 50", "operationId": "CustomerPrivacyChangePrivateCustomerIdBatch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumChangeCustomerId" }, "description": "" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumChangeCustomerId" }, "description": "" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumChangeCustomerId" }, "description": "" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumChangeCustomerId" }, "description": "" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/CustomerPrivacy/ChangeBusinessCustomerId": { "get": { "tags": [ "Customers | B2C | Privacy" ], "summary": "Change business customer id, and all data assosiated with that id over to new customer object.", "operationId": "CustomerPrivacyChangeBusinessCustomerId", "parameters": [ { "name": "fromCustomerId", "in": "query", "description": "Move data from this customer. Customer with this id will also be deleted!", "required": true, "schema": { "type": "string", "description": "Move data from this customer. Customer with this id will also be deleted!" } }, { "name": "toCustomerId", "in": "query", "description": "Move data to this customer. Created if not exist.", "required": true, "schema": { "type": "string", "description": "Move data to this customer. Created if not exist." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumBusinessCustomer" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/DatePlanners": { "get": { "tags": [ "Date Planners" ], "summary": "Gets a single date planner", "operationId": "DatePlannersGet", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Date Planners" ], "summary": "Create or overwrite a date planner.", "operationId": "DatePlannersPut", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Date Planners" ], "summary": "Delete a date planner", "operationId": "DatePlannersDelete", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDatePlanner" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Deliveries/{deliveryId}": { "get": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Get delivery", "operationId": "DeliveriesGetDelivery", "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Patch delivery", "description": "Patch delivery", "operationId": "DeliveriesPatch", "parameters": [ { "name": "deliveryId", "in": "path", "description": "Delivery ID to patch", "required": true, "schema": { "type": "string", "description": "Delivery ID to patch", "nullable": true } } ], "requestBody": { "description": "Delivery patch", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryPatch" } } } }, "400": { "description": "Bad Request" } } } }, "/api/Deliveries/{deliveryId}/PurchaseOrderLines": { "get": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Get delivery purchase order lines", "operationId": "DeliveriesGetDeliveryPurchaseOrderLines", "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLine" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLine" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLine" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries/Search": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Search deliveries", "description": "Search deliveries", "operationId": "DeliveriesSearch", "requestBody": { "description": "Search request object for deliveries", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDeliverySearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliverySearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliverySearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDeliverySearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDeliveryOmniumSearchResult" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries/CreateDelivery/{purchaseOrderId}": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Create delivery with purchase order lines. Use either SKU or Code to identify line items. Package SKU ID can be set but is not required.", "description": "Create delivery from order lines. Use either SKU or Code to identify line items. Package SKU ID can be set but is not required.", "operationId": "DeliveriesCreateDelivery", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "existingDeliveryId", "in": "query", "description": "If set, the purchase order lines will be added to the existing delivery", "schema": { "type": "string", "description": "If set, the purchase order lines will be added to the existing delivery", "nullable": true } }, { "name": "cancelRemainingLineItems", "in": "query", "description": "If true, remaining line items on purchase order will be cancelled", "schema": { "type": "boolean", "description": "If true, remaining line items on purchase order will be cancelled", "nullable": true } }, { "name": "expectedDeliveryDate", "in": "query", "description": "", "schema": { "type": "string", "description": "", "format": "date-time", "nullable": true } }, { "name": "barcode", "in": "query", "description": "Use this to add barcode to the shipment. Used for goodsreception", "schema": { "type": "string", "description": "Use this to add barcode to the shipment. Used for goodsreception", "nullable": true } }, { "name": "newDeliveryId", "in": "query", "description": "You can pick the Id of the new delivery. Do this at your own responsibility.", "schema": { "type": "string", "description": "You can pick the Id of the new delivery. Do this at your own responsibility.", "nullable": true } }, { "name": "preventDuplicateLineItems", "in": "query", "description": "If true, the request will fail with BadRequest if duplicate line item IDs are found", "schema": { "type": "boolean", "description": "If true, the request will fail with BadRequest if duplicate line item IDs are found", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLineReference" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLineReference" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLineReference" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLineReference" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries": { "put": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Update delivery", "description": "Update delivery", "operationId": "DeliveriesUpdate", "requestBody": { "description": "Delivery", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries/UpdateMany": { "put": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Update many deliveries", "description": "Update many deliveries", "operationId": "DeliveriesUpdateMany", "requestBody": { "description": "Deliveries", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDelivery" }, "description": "Deliveries", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDelivery" }, "description": "Deliveries", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDelivery" }, "description": "Deliveries", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDelivery" }, "description": "Deliveries", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDelivery" } } } }, "400": { "description": "Bad Request" } } } }, "/api/Deliveries/{deliveryId}/AddPublicDeliveryComment": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Add public delivery comment", "description": "Add public delivery comment", "operationId": "DeliveriesAddPublicDeliveryComment", "parameters": [ { "name": "deliveryId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries/{deliveryId}/AddInternalDeliveryComment": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Add internal delivery comment", "description": "Add internal delivery comment", "operationId": "DeliveriesAddInternalDeliveryComment", "parameters": [ { "name": "deliveryId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/api/Deliveries/ProcessGoodsReception": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Process goods reception", "description": "Process goods reception", "operationId": "DeliveriesProcessGoodsReception", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request" } } } }, "/api/Deliveries/{deliveryId}/ProcessGoodsReception": { "post": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Process goods reception", "description": "Process goods reception", "operationId": "DeliveriesProcessGoodsReceptionForDelivery", "parameters": [ { "name": "deliveryId", "in": "path", "description": "Id of delivery containing the line items", "required": true, "schema": { "type": "string", "description": "Id of delivery containing the line items", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDeliveryGoodsReceptionLine" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request" } } } }, "/api/Deliveries/{id}": { "delete": { "tags": [ "Purchase Orders | Deliveries" ], "summary": "Delete delivery", "operationId": "DeliveriesDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Delivery is deleted" }, "400": { "description": "Invalid request" }, "404": { "description": "Delivery not found" } } } }, "/api/EventLog/Search": { "post": { "tags": [ "Event Log" ], "summary": "Search in the event log", "operationId": "EventLogSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumEventLogItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogItemOmniumResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/EventLog/SearchByPrevious/{eventLogModel}/{objectId}": { "post": { "tags": [ "Event Log" ], "summary": "Search for events based on previous event", "operationId": "EventLogSearchByPrevious", "parameters": [ { "name": "eventLogModel", "in": "path", "description": "Type of the object the event occured for", "required": true, "schema": { "$ref": "#/components/schemas/OmniumEventLogModelType" } }, { "name": "objectId", "in": "path", "description": "Id of the object the event occured for", "required": true, "schema": { "type": "string", "description": "Id of the object the event occured for", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogCompareRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogCompareRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogCompareRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumEventLogCompareRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEventLogItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEventLogItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEventLogItem" } } } } }, "204": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Files/{serviceType}/Download": { "post": { "tags": [ "Assets | Files" ], "summary": "Download file/asset with a give path and serviceType. ServiceType is found on the asset", "operationId": "FilesDownload", "parameters": [ { "name": "serviceType", "in": "path", "description": "The service type which should be specified on the asset", "required": true, "schema": { "type": "string", "description": "The service type which should be specified on the asset" } } ], "requestBody": { "description": "File path", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumFileDownloadRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumFileDownloadRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumFileDownloadRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumFileDownloadRequest" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid service type" }, "404": { "description": "Asset was not found with the selected service type" } } } }, "/api/GiftCard/Search": { "post": { "tags": [ "Orders | Gift Cards" ], "summary": "Search gift cards", "operationId": "GiftCardSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returns list of gift cards", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } } } } } } }, "/api/GiftCard/Scroll": { "post": { "tags": [ "Orders | Gift Cards" ], "summary": "Scroll gift cards by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.", "operationId": "GiftCardScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning gift cards", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumSearchResult" } } } }, "400": { "description": "Search request invalid" } } } }, "/api/GiftCard/Scroll/{id}": { "get": { "tags": [ "Orders | Gift Cards" ], "summary": "Scroll gift card is used to get a large number of gift cards.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "GiftCardScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCardOmniumResult" } } } } } } }, "/api/GiftCard/{code}": { "get": { "tags": [ "Orders | Gift Cards" ], "summary": "Get gift card by gift card code", "operationId": "GiftCardGet", "parameters": [ { "name": "code", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "marketId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "giftCardPin", "in": "query", "description": "Gift card PIN, if required, along with the code provided by the gift card provider.", "schema": { "type": "string", "description": "Gift card PIN, if required, along with the code provided by the gift card provider.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Gift card found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumGiftCard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGiftCard" } } } }, "404": { "description": "Gift card does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Health": { "get": { "tags": [ "Health" ], "summary": "Omnium health check", "operationId": "HealthHealth", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/ImagesDelivery/GetImageUrl": { "get": { "tags": [ "Assets | Images", "Products" ], "summary": "Based on a image url that exists in Omnium, generate a new size.If both width and height is specified, width is used", "operationId": "ImagesDeliveryGetImageUrl", "parameters": [ { "name": "url", "in": "query", "description": "Complete url to the image", "schema": { "type": "string", "description": "Complete url to the image", "nullable": true } }, { "name": "maxHeight", "in": "query", "description": "Max height for the generated image", "schema": { "type": "integer", "description": "Max height for the generated image", "format": "int32", "default": 50 } }, { "name": "maxWidth", "in": "query", "description": "Max width for the generated image", "schema": { "type": "integer", "description": "Max width for the generated image", "format": "int32", "default": 0 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" } } } }, "/api/Insights/Orders": { "post": { "tags": [ "Insights" ], "summary": "Daily order statistics per store: counts, delivery-type splits, revenue (incl. and excl. VAT), and orders-by-status.", "operationId": "InsightsGetOrders", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsOrderDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsOrderDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsOrderDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Products": { "post": { "tags": [ "Insights" ], "summary": "Daily product sales per store, grouped by top-level category. Returns the top 20 SKUs per category by revenue.", "operationId": "InsightsGetProducts", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProductDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProductDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProductDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Projects/Activity": { "post": { "tags": [ "Insights" ], "summary": "Daily project transitions per store and project type (new, completed, cancelled, estimated value).", "operationId": "InsightsGetProjectsActivity", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectActivityDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectActivityDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectActivityDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Projects/InProgress": { "post": { "tags": [ "Insights" ], "summary": "Current snapshot of projects in progress (non-terminal status) created within the date window. Not a daily series.", "operationId": "InsightsGetProjectsInProgress", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectInProgressResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectInProgressResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsProjectInProgressResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Loyalty/Orders": { "post": { "tags": [ "Insights" ], "summary": "Daily order statistics per store split by customer-club membership (member vs non-member). Guest orders count as non-member.", "operationId": "InsightsGetLoyaltyOrders", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyOrderDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyOrderDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyOrderDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Loyalty/Members": { "post": { "tags": [ "Insights" ], "summary": "Daily new customer-club registrations per store, based on MemberSince.", "operationId": "InsightsGetLoyaltyMembers", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyMemberDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyMemberDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsLoyaltyMemberDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Returns": { "post": { "tags": [ "Insights" ], "summary": "Daily return statistics per store: return count, pro-rated return value, and return rate against orders created on the same day.", "operationId": "InsightsGetReturns", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsReturnDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsReturnDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsReturnDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Insights/Promotions": { "post": { "tags": [ "Insights" ], "summary": "Daily promotion redemption statistics per store. DiscountValue covers only single-promotion order lines; DiscountValueCoverage reports the coverage ratio.", "operationId": "InsightsGetPromotions", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInsightsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsPromotionDailyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsPromotionDailyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsPromotionDailyResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Inventory/{id}": { "get": { "tags": [ "Products | Inventory" ], "summary": "Returns inventory items for a single sku", "operationId": "InventoryGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of the sku to return", "required": true, "schema": { "type": "string", "description": "ID of the sku to return", "nullable": true } }, { "name": "warehouseIds", "in": "query", "description": "Warehouse ids for inventory", "schema": { "type": "array", "items": { "type": "string" }, "description": "Warehouse ids for inventory", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } } } } } }, "delete": { "tags": [ "Products | Inventory" ], "summary": "Deletes inventory for a single sku, for selected warehouses", "operationId": "InventoryDelete", "parameters": [ { "name": "id", "in": "path", "description": "ID of the sku to delete", "required": true, "schema": { "type": "string", "description": "ID of the sku to delete", "nullable": true } }, { "name": "warehouseIds", "in": "query", "description": "Warehouse ids for inventory to delete", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Warehouse ids for inventory to delete" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory": { "post": { "tags": [ "Products | Inventory" ], "summary": "Add a new inventory item to the OMS", "operationId": "InventoryPost", "requestBody": { "description": "Inventory object that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } }, "delete": { "tags": [ "Products | Inventory" ], "summary": "Deletes inventory for multiple skus, for selected warehouses", "operationId": "InventoryDeleteMany", "parameters": [ { "name": "warehouseIds", "in": "query", "description": "Warehouse ids for inventory to delete", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Warehouse ids for inventory to delete" } } ], "requestBody": { "description": "SkuIds to delete inventory for", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "SkuIds to delete inventory for" } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "SkuIds to delete inventory for" } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "SkuIds to delete inventory for" } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "SkuIds to delete inventory for" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } }, "patch": { "tags": [ "Products | Inventory" ], "summary": "Patch an inventory item - update only the values present in the request. Only updates items that already exist - does not create new inventory entries.\r\nThe item is identified by SkuId and WarehouseCode (and optionally VirtualWarehouseCode). Quantities (Inventory / ReservedInventory) are not patchable here -\r\nuse ProcessInventoryTransactions (delta) or UpdateMany (total) for those.", "operationId": "InventoryPatchInventoryItem", "requestBody": { "description": "Patch request containing the identifiers and fields to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Inventory item patch processed (see result for details)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } } } }, "400": { "description": "Patch request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Inventory item not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Inventory/AddMany": { "post": { "tags": [ "Products | Inventory" ], "summary": "Add a range of inventory items to the OMS. This will override existing items even if the values are identical, and also create inventory transactions.\r\nPlease note: It is strongly recommended that you only use this endpoint for one-time imports.\r\nFor everything else (such as continuous updates, new import, nightly full imports, etc.), please use UpdateMany instead.", "operationId": "InventoryAddMany", "requestBody": { "description": "A list of inventory items objects that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory/Update": { "put": { "tags": [ "Products | Inventory" ], "summary": "Update inventory", "operationId": "InventoryUpdate", "requestBody": { "description": "The inventory object to be updated in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItem" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory/UpdateMany": { "put": { "tags": [ "Products | Inventory" ], "summary": "Update a range of inventory items to the OMS.", "operationId": "InventoryUpdateMany", "parameters": [ { "name": "isReservedInventoryOverwritten", "in": "query", "description": "Set to 'true' if reserved inventory should be overwritten with the values in the request. Defaults to 'false'.", "schema": { "type": "boolean", "description": "Set to 'true' if reserved inventory should be overwritten with the values in the request. Defaults to 'false'." } } ], "requestBody": { "description": "A list of inventory items objects that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "A list of inventory items objects that needs to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory/ProcessInventoryTransactions": { "post": { "tags": [ "Products | Inventory" ], "summary": "Perform inventory updates by specifying delta instead of total. Supports multiple updates to the same inventory item in the same request.", "operationId": "InventoryProcessInventoryTransactions", "requestBody": { "description": "List of Inventory updates object", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryUpdate" }, "description": "List of Inventory updates object", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryUpdate" }, "description": "List of Inventory updates object", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryUpdate" }, "description": "List of Inventory updates object", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryUpdate" }, "description": "List of Inventory updates object", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory/RecalculateReservedInventory": { "get": { "tags": [ "Products | Inventory" ], "summary": "Recalculates all inventory items with reservations", "operationId": "InventoryRecalculateReservedInventory", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "500": { "description": "Server Error" } } } }, "/api/Inventory/Scroll/{id}": { "get": { "tags": [ "Products | Inventory" ], "summary": "Scroll inventory is used to get a large amount of inventory items.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "InventoryScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Inventory/Search": { "post": { "tags": [ "Products | Inventory" ], "summary": "Search inventory items using available parameters in OmniumInventorySearchRequest.", "description": "Sample request for a delta query:\r\n\r\n POST /api/inventory/search\r\n {\r\n \"LastModified\": \"2019-11-21T17:32:28Z\"\r\n }\r\n \r\nSample request for inventory for a specific market\r\n\r\n POST /api/inventory/search\r\n {\r\n \"MarketId:\" \"NOR\"\r\n } \r\n\r\nSamples response if the number of inventory items exceeds 1000 (totalHits).\r\n
\r\nNotice that the 'scrollId' property has been populated as totalHits exceeds 1000, meaning that you should use the scroll endpoint to fetch remaining inventory items\r\n \r\n {\r\n \"totalHits\": 41244,\r\n \"result\": [\r\n {\r\n \"sku\": \"102103\",\r\n \"warehouseCode\": \"40\",\r\n \"inventory\": 33,\r\n \"reservedInventory\": 7,\r\n \"location\": \"32D-A2\"\r\n },\r\n {\r\n \"sku\": \"102104\",\r\n ...\r\n }\r\n ],\r\n \"scrollId\": \"2f842421e06e4c60bb2c4f0d8b3ef60b\"\r\n }\r\n \r\n\r\nPlease note that if the total amount is larger than 2000, the response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.", "operationId": "InventorySearch", "requestBody": { "description": "The InventorySearchRequest contains properties for filtering inventory", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInventorySearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventorySearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventorySearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInventorySearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning inventory items", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemOmniumResult" } } } }, "400": { "description": "Search request invalid" } } } }, "/api/Inventory/ScrollTransactions/{id}": { "get": { "tags": [ "Products | Inventory" ], "summary": "Scroll inventory transactions is used to get a large amount of inventory transactions.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "InventoryScrollTransactions", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Inventory/SearchTransactions": { "post": { "tags": [ "Products | Inventory" ], "summary": "Search inventory transactions using available parameters in OmniumInventoryTransactionSearchRequest.", "description": "Sample request for a transaction search by SKU:\r\n\r\n POST /api/inventory/searchtransactions\r\n {\r\n \"skuId\": \"ABC123\",\r\n \"take\": 50,\r\n \"page\": 1\r\n }\r\n \r\nSample request for transactions within a date range:\r\n\r\n POST /api/inventory/searchtransactions\r\n {\r\n \"from\": \"2024-01-01T00:00:00Z\",\r\n \"to\": \"2024-01-31T23:59:59Z\",\r\n \"take\": 100,\r\n \"page\": 1\r\n }\r\n \r\nSample response if the number of inventory transactions exceeds 2000 (totalHits).\r\n
\r\nNotice that the 'scrollId' property has been populated as totalHits exceeds 2000, meaning that you should use the ScrollTransactions endpoint to fetch remaining inventory transactions\r\n \r\n {\r\n \"totalHits\": 15000,\r\n \"result\": [\r\n {\r\n \"variant\": \"ABC123\",\r\n \"warehouseCode\": \"WH001\",\r\n \"inventoryChange\": 5,\r\n \"transactionDate\": \"2024-01-15T10:30:00Z\",\r\n \"transactionType\": \"PurchaseOrder\"\r\n },\r\n {\r\n \"variant\": \"ABC124\",\r\n ...\r\n }\r\n ],\r\n \"scrollId\": \"2f842421e06e4c60bb2c4f0d8b3ef60b\"\r\n }\r\n \r\n\r\nPlease note that if the total amount is larger than 2000, the response will contain a Scroll ID which can be used with the ScrollTransactions endpoint to fetch all remaining transactions.", "operationId": "InventorySearchInventoryTransactions", "requestBody": { "description": "The search request contains properties for filtering inventory transactions", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning inventory transactions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryTransactionOmniumResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Inventory/TransferLocation": { "post": { "tags": [ "Products | Inventory" ], "summary": "Transfer inventory between locations within a warehouse, or assign unlocated stock to a location", "operationId": "InventoryTransferLocation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumLocationTransferRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumLocationTransferRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumLocationTransferRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumLocationTransferRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Inventory/SetDefaultLocation": { "post": { "tags": [ "Products | Inventory" ], "summary": "Set the default location for a SKU in a warehouse", "operationId": "InventorySetDefaultLocation", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSetDefaultLocationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSetDefaultLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSetDefaultLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSetDefaultLocationRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Inventory/UpdateAtp": { "put": { "tags": [ "Products | Inventory" ], "summary": "Update ATP (Available-to-Promise) values on existing inventory items. Only updates items that already exist — does not create new inventory entries.", "operationId": "InventoryUpdateAtp", "requestBody": { "description": "List of ATP updates, each targeting a specific SKU and warehouse", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtpUpdate" }, "description": "List of ATP updates, each targeting a specific SKU and warehouse", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtpUpdate" }, "description": "List of ATP updates, each targeting a specific SKU and warehouse", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtpUpdate" }, "description": "List of ATP updates, each targeting a specific SKU and warehouse", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtpUpdate" }, "description": "List of ATP updates, each targeting a specific SKU and warehouse", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Inventory/PatchMany": { "patch": { "tags": [ "Products | Inventory" ], "summary": "Patch many inventory items - update only the values present in each request. Only updates items that already exist - does not create new inventory entries.\r\nEach item is identified by SkuId and WarehouseCode (and optionally VirtualWarehouseCode). Quantities (Inventory / ReservedInventory) are not patchable here.", "operationId": "InventoryPatchMany", "requestBody": { "description": "List of patch requests", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" }, "description": "List of patch requests", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" }, "description": "List of patch requests", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" }, "description": "List of patch requests", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItemPatch" }, "description": "List of patch requests", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Inventory item patches processed (see result for details)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInventoryItemUpdateResult" } } } }, "400": { "description": "Patch request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Invoices": { "get": { "tags": [ "Invoices" ], "summary": "Get all invoices", "operationId": "InvoicesGetInvoices", "parameters": [ { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 20 } }, { "name": "isPaid", "in": "query", "description": "Filter on paid or unpaid invoices. Leave unassigned to get all.", "schema": { "type": "boolean", "description": "Filter on paid or unpaid invoices. Leave unassigned to get all.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoices found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid" }, "404": { "description": "No invoices found" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/{invoiceId}": { "get": { "tags": [ "Invoices" ], "summary": "Returns a single invoice", "operationId": "InvoicesGet", "parameters": [ { "name": "invoiceId", "in": "path", "description": "Invoice ID", "required": true, "schema": { "type": "string", "description": "Invoice ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoice found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "400": { "description": "Invoice ID is invalid" }, "404": { "description": "Invoice does not exist" }, "500": { "description": "Server Error" } } }, "delete": { "tags": [ "Invoices" ], "summary": "Delete invoice and related invoice file", "description": "Delete Invoice and related invoice file", "operationId": "InvoicesDelete", "parameters": [ { "name": "invoiceId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoice added successfully" }, "400": { "description": "Bad request" }, "404": { "description": "Not found" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/Customers/{customerId}": { "get": { "tags": [ "Invoices" ], "summary": "Get all invoices associated with customer", "operationId": "InvoicesGetInvoicesByCustomer", "parameters": [ { "name": "customerId", "in": "path", "description": "Customer identification", "required": true, "schema": { "type": "string", "description": "Customer identification", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 20 } }, { "name": "isPaid", "in": "query", "description": "If the invoices are paid or not", "schema": { "type": "boolean", "description": "If the invoices are paid or not", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoices found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid" }, "404": { "description": "No invoices found" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/GetAsPdf/{invoiceId}": { "get": { "tags": [ "Invoices" ], "summary": "Get copy of invoice", "operationId": "InvoicesGetAsPdf", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "application/pdf": { "schema": { "type": "file" } } } }, "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found" } } } }, "/api/Invoices/UpdateInvoice": { "put": { "tags": [ "Invoices" ], "summary": "Add/Update invoice", "description": "Add a new invoice, or update an existing invoice", "operationId": "InvoicesUpdateInvoice", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoice added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Invalid data" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/Search": { "post": { "tags": [ "Invoices" ], "summary": "Search for invoices", "description": "Search for invoices.", "operationId": "InvoicesSearch", "requestBody": { "description": "Invoice search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoices found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumInvoiceTotalsOmniumSearchResultWithTotals" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumInvoiceTotalsOmniumSearchResultWithTotals" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumInvoiceTotalsOmniumSearchResultWithTotals" } } } }, "400": { "description": "Parameters are invalid" }, "404": { "description": "No invoices found" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/AddInvoice": { "post": { "tags": [ "Invoices" ], "summary": "Upload invoice-file from stream - creates new invoice", "description": "Upload invoice-file from stream. Creates a new invoice. Use UpdateInvoice to populate object with additional data.", "operationId": "InvoicesAddInvoice", "parameters": [ { "name": "fileName", "in": "query", "description": "Name of uploaded invoice file", "required": true, "schema": { "type": "string", "description": "Name of uploaded invoice file" } }, { "name": "projectId", "in": "query", "description": "Project connected to the created invoice (Optional)", "schema": { "type": "string", "description": "Project connected to the created invoice (Optional)", "nullable": true } }, { "name": "orderId", "in": "query", "description": "Order connected to the created invoice (Optional)", "schema": { "type": "string", "description": "Order connected to the created invoice (Optional)", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Invoice added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Invalid projectId" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/{invoiceId}/AddFileToInvoice": { "post": { "tags": [ "Invoices" ], "summary": "Upload invoice-file from stream - attach to existing invoice", "description": "Upload invoice-file from stream. Attaches the file to an existing invoice", "operationId": "InvoicesAddFileToInvoice", "parameters": [ { "name": "invoiceId", "in": "path", "description": "id of the invoice", "required": true, "schema": { "type": "string", "description": "id of the invoice", "nullable": true } }, { "name": "fileName", "in": "query", "description": "name of file", "schema": { "type": "string", "description": "name of file", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoice added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Invalid invoiceId - invoice does not exist" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/{invoiceId}/AddAsset": { "post": { "tags": [ "Invoices" ], "summary": "Add asset to invoice from stream.\r\nIf assetId is supplied and an asset already exists with the given ID, then asset will be patched with the supplied data.\r\nIf assetId is supplied and no asset with the given ID exists, then the created asset will be assigned the supplied assetId.\r\nIf assetId is empty, a new asset will be created and assigned a guid as ID.", "description": "Add new invoice asset from stream", "operationId": "InvoicesAddAsset", "parameters": [ { "name": "invoiceId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "fileName", "in": "query", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "assetId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoice" } } } }, "400": { "description": "Bad request" }, "404": { "description": "Invoice does not exist" }, "500": { "description": "Server Error" } } } }, "/api/Invoices/Orders/{orderId}": { "get": { "tags": [ "Orders | Invoices" ], "summary": "Get all invoices associated with order", "operationId": "InvoicesGetInvoicesByOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "Order identification", "required": true, "schema": { "type": "string", "description": "Order identification", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 20 } }, { "name": "isPaid", "in": "query", "description": "If the invoices are paid or not", "schema": { "type": "boolean", "description": "If the invoices are paid or not", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoices found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid" }, "404": { "description": "No invoices found" }, "500": { "description": "Server Error" } } } }, "/api/Markets": { "get": { "tags": [ "Markets" ], "summary": "Get all markets", "operationId": "MarketsGet", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Markets found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarket" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarket" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarket" } } } } }, "404": { "description": "No markets found" } } } }, "/api/Markets/GetMarketGroups": { "get": { "tags": [ "Markets" ], "summary": "Get all market groups", "operationId": "MarketsGetMarketGroups", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Market groups found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarketGroup" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarketGroup" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumMarketGroup" } } } } }, "404": { "description": "No market groups found" } } } }, "/api/Markets/Update": { "put": { "tags": [ "Markets" ], "summary": "Update market", "operationId": "MarketsUpdate", "requestBody": { "description": "The market to be updated in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumMarket" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumMarket" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumMarket" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumMarket" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Markets/{marketId}/Delete": { "delete": { "tags": [ "Markets" ], "summary": "Delete market - This operation does not clean up other resources or references in Omnium, it only removes the market from the settings.", "operationId": "MarketsDelete", "parameters": [ { "name": "marketId", "in": "path", "description": "Id of the market to be deleted in the OMS", "required": true, "schema": { "type": "string", "description": "Id of the market to be deleted in the OMS", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Marked deleted" }, "500": { "description": "Internal server error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Notifications/SendEmail": { "post": { "tags": [ "Notifications" ], "summary": "Send E-mail", "operationId": "NotificationsSendEmail", "requestBody": { "description": "E-mail-message to send", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Email is sent" }, "400": { "description": "Email is invalid" } } } }, "/api/Notifications/SendSms": { "post": { "tags": [ "Notifications" ], "summary": "Send SMS", "operationId": "NotificationsSendSms", "requestBody": { "description": "SMS-message to send", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "SMS is sent" }, "400": { "description": "SMS is invalid" } } } }, "/api/Orders": { "post": { "tags": [ "Orders | Update" ], "summary": "Add a new order to the OMS.", "description": "Sample request for adding a basic order with one order line, 50% discount, paid with Klarna and delivered by PostNord.\r\n \r\n POST /api/orders\r\n {\r\n \"id\": \"EPIC000001\",\r\n \"customerId\": \"4793246662\",\r\n \"billingCurrency\": \"NOK\",\r\n \"customerName\": \"Ola Nordmann\",\r\n \"marketId\": \"epic_market_no\",\r\n \"storeId\": \"epic_webshop_no\",\r\n \"customerPhone\": \"4793246662\",\r\n \"customerEmail\": \"ola.nordmann@omnium.no\",\r\n \"status\": \"New\",\r\n \"billingAddress\": {\r\n \"daytimePhoneNumber\": \"4793246662\",\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryCode\": \"NO\",\r\n \"countryName\": \"Norge\",\r\n \"postalCode\": \"1415\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n },\r\n \"orderForm\": {\r\n \"payments\": [\r\n {\r\n \"amount\": 49.5,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"123456789\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"PostNord\",\r\n \"warehouseCode\": \"epic_company_main_warehouse\",\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"address\": {\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryName\": \"Norge\",\r\n \"countryCode\": \"NO\",\r\n \"postalCode\": \"0159\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n }\r\n }\r\n ],\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"discounts\": [\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"Fifty percent discount!\",\r\n \"discountValue\": 50,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n ]\r\n },\r\n \"orderType\": \"Online\"\r\n }", "operationId": "OrdersPost", "requestBody": { "description": "Order object that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Could not add order. Order with the same order ID has already been added.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Orders | Update" ], "summary": "Create a new order in the OMS, with an auto generated order number (orderNumber). \r\nIf ID is not specified when creating the order, it will be set to the newly generated order number.", "description": "Sample request:\r\n\r\n PUT /api/orders\r\n {\r\n \"id\": \"NotNeededButMayBeSpecified\",\r\n \"customerId\": \"4793246662\",\r\n \"billingCurrency\": \"NOK\",\r\n \"customerName\": \"Ola Nordmann\",\r\n \"marketId\": \"epic_market_no\",\r\n \"storeId\": \"epic_webshop_no\",\r\n \"customerPhone\": \"4793246662\",\r\n \"customerEmail\": \"ola.nordmann@omnium.no\",\r\n \"status\": \"New\",\r\n \"billingAddress\": {\r\n \"daytimePhoneNumber\": \"4793246662\",\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryCode\": \"NO\",\r\n \"countryName\": \"Norge\",\r\n \"postalCode\": \"1415\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n },\r\n \"orderForm\": {\r\n \"payments\": [\r\n {\r\n \"amount\": 49.5,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"123456789\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"PostNord\",\r\n \"warehouseCode\": \"epic_company_main_warehouse\",\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"address\": {\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryName\": \"Norge\",\r\n \"countryCode\": \"NO\",\r\n \"postalCode\": \"0159\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n }\r\n }\r\n ],\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"discounts\": [\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"Fifty percent discount!\",\r\n \"discountValue\": 50,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n ]\r\n },\r\n \"orderType\": \"Online\"\r\n }", "operationId": "OrdersCreate", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Could not add order. Order with the same ID has already been added.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/PosOrders": { "put": { "tags": [ "Orders | Others" ], "summary": "Create a new Pos order in OMS.", "description": "This will be saved as a OmniumOrder. For more information about properties, see OmniumOrder model.\r\n
\r\n### Notes ###\r\n- **OrderType** will be set to Pos.\r\n- If **Created** is not set, it will be set to utc now.\r\n- **Status** wil be set to Completed\r\n\r\nFollowing properties is required:\r\n- **MarketId**: Should be set to a market in Omnium.\r\n- **OrderNumber**: Must be unique.\r\n- **StoreId**: Must match a store in Omnium\r\n \r\nSample request for a Pos order. \r\n\r\n {\r\n \"customerId\": \"4712345678\", \r\n \"customerName\": \"Ola Nordmann\",\r\n \"customerPhone\": \"+4712345678\", \r\n \"marketId\": \"No\",\r\n \"storeId\": \"TestStore\",\r\n \"orderNumber\": \"PO-123456\",\r\n \"created\": \"2018-08-01T00:00:00Z\",\r\n \"orderForm\": {\r\n \"lineItems\": [\r\n {\r\n \"code\": \"Ab1234\",\r\n \"displayName\": \"Faded glory\",\r\n \"placedPrice\": 100,\r\n \"placedPriceExclTax\": 80,\r\n \"extendedPrice\": 200,\r\n \"extendedPriceExclTax\": 160,\r\n \"quantity\": 2,\r\n \"taxTotal\": 40,\r\n \"taxRate\": 25\r\n }\r\n ]\r\n }\r\n }", "operationId": "OrdersCreatePosOrder", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Order created successfully" }, "400": { "description": "Request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Update": { "post": { "tags": [ "Orders | Batch Updates" ], "summary": "Update an order.", "description": "Sample request:\r\n \r\n POST /api/orders/Update?runWorkflow=true\r\n {\r\n \"id\": \"EPIC000001\",\r\n \"customerId\": \"4793246662\",\r\n \"billingCurrency\": \"NOK\",\r\n \"customerName\": \"Ola Nordmann\",\r\n \"marketId\": \"epic_market_no\",\r\n \"storeId\": \"epic_webshop_no\",\r\n \"customerPhone\": \"4793246662\",\r\n \"customerEmail\": \"ola.nordmann@omnium.no\",\r\n \"status\": \"New\",\r\n \"billingAddress\": {\r\n \"daytimePhoneNumber\": \"4793246662\",\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryCode\": \"NO\",\r\n \"countryName\": \"Norge\",\r\n \"postalCode\": \"1415\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n },\r\n \"orderForm\": {\r\n \"payments\": [\r\n {\r\n \"amount\": 49.5,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"123456789\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"PostNord\",\r\n \"warehouseCode\": \"epic_company_main_warehouse\",\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"address\": {\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryName\": \"Norge\",\r\n \"countryCode\": \"NO\",\r\n \"postalCode\": \"0159\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n }\r\n }\r\n ],\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"discounts\": [\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"Fifty percent discount!\",\r\n \"discountValue\": 50,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n ]\r\n },\r\n \"orderType\": \"Online\"\r\n }", "operationId": "OrdersUpdate", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, the workflow will be processed.", "schema": { "type": "boolean", "description": "If true, the workflow will be processed.", "default": false } } ], "requestBody": { "description": "The order to update.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The order was updated successfully and the workflow was executed.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "400": { "description": "The request was invalid.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while updating the order.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Orders | Batch Updates" ], "summary": "Put an order. CAUTION: overwriting existing order.", "description": "Sample request:\r\n \r\n PUT /api/orders/Update\r\n {\r\n \"id\": \"EPIC000001\",\r\n \"customerId\": \"4793246662\",\r\n \"billingCurrency\": \"NOK\",\r\n \"customerName\": \"Ola Nordmann\",\r\n \"marketId\": \"epic_market_no\",\r\n \"storeId\": \"epic_webshop_no\",\r\n \"customerPhone\": \"4793246662\",\r\n \"customerEmail\": \"ola.nordmann@omnium.no\",\r\n \"status\": \"New\",\r\n \"billingAddress\": {\r\n \"daytimePhoneNumber\": \"4793246662\",\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryCode\": \"NO\",\r\n \"countryName\": \"Norge\",\r\n \"postalCode\": \"1415\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n },\r\n \"orderForm\": {\r\n \"payments\": [\r\n {\r\n \"amount\": 49.5,\r\n \"paymentMethodName\": \"Klarna\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"123456789\",\r\n \"transactionType\": \"Authorization\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"shipmentId\": \"1\",\r\n \"shippingMethodName\": \"PostNord\",\r\n \"warehouseCode\": \"epic_company_main_warehouse\",\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"address\": {\r\n \"name\": \"Ola Nordmann\",\r\n \"line1\": \"Lille Grensen 3\",\r\n \"city\": \"Oslo\",\r\n \"countryName\": \"Norge\",\r\n \"countryCode\": \"NO\",\r\n \"postalCode\": \"0159\",\r\n \"email\": \"ola.nordmann@omnium.no\"\r\n }\r\n }\r\n ],\r\n \"lineItems\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"0123ABC\",\r\n \"placedPrice\": 99.0,\r\n \"quantity\": 1.0,\r\n \"taxRate\": 25\r\n }\r\n ],\r\n \"discounts\": [\r\n {\r\n \"discountType\": \"Order\",\r\n \"discountName\": \"Fifty percent discount!\",\r\n \"discountValue\": 50,\r\n \"rewardType\": \"Percentage\"\r\n }\r\n ]\r\n },\r\n \"orderType\": \"Online\"\r\n }", "operationId": "OrdersOverwrite", "requestBody": { "description": "The order to update/overwrite.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The order was updated successfully.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "400": { "description": "The request was invalid.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while updating the order.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The user has not access to overwrite the order." } } } }, "/api/Orders/UpdateMany": { "post": { "tags": [ "Orders | Batch Updates" ], "summary": "Update a range of orders. Adds order if order does not already exist.", "operationId": "OrdersUpdateMany", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, workflow will run based on order status. False, will only save updated order", "schema": { "type": "boolean", "description": "If true, workflow will run based on order status. False, will only save updated order" } } ], "requestBody": { "description": "A list of orders to update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of orders to update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of orders to update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of orders to update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of orders to update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/AddMany": { "post": { "tags": [ "Orders | Batch Updates" ], "summary": "Adds a range of new orders to the OMS. Does not overwrite existing orders.", "operationId": "OrdersAddMany", "requestBody": { "description": "A list of Order objects that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/ImportMany": { "post": { "tags": [ "Orders | Batch Updates" ], "summary": "Adds a range of orders to the OMS, without running workflows.", "operationId": "OrdersImportMany", "requestBody": { "description": "A list of Order objects that needs to be imported to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be imported to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be imported to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be imported to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "A list of Order objects that needs to be imported to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/AddPayments": { "put": { "tags": [ "Orders | Payments" ], "summary": "Add new payments to an existing order. Will overwrite payments with matching Id, and add payments where no exiting payment with matching Id exists. NB! Payments with Id null will always be appended to payment list.", "description": " Sample request for adding payments to an order:\r\n\r\n PUT /api/orders/EPIC000001/AddPayments\r\n {\r\n\t \"payments\": [\r\n\t\t {\r\n\t\t\t \"amount\": 100.0,\r\n\t\t\t \"authorizationCode\": \"123456\",\r\n\t\t\t \"customerName\": \"John Doe\",\r\n\t\t\t \"id\": \"abc123\",\r\n\t\t \t \"paymentMethodName\": \"Klarna\",\r\n\t\t \t \"paymentType\": \"Invoice\",\r\n\t\t \t \"status\": \"Processed\",\r\n\t\t \t\"transactionId\": \"xyz789\",\r\n\t\t \t\"transactionType\": \"Authorization\",\r\n\t\t \t\"properties\": [\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property1\",\r\n\t\t\t \t\t \"value\": \"Value1\"\r\n\t\t\t \t },\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property2\",\r\n\t\t\t \t\t \"value\": \"Value2\"\r\n\t\t\t \t }\r\n\t\t \t ],\r\n\t\t\t \"paidDate\": \"2021-10-01T00:00:00Z\",\r\n\t\t\t \"created\": \"2021-09-01T00:00:00Z\",\r\n\t\t\t \"isManuallyAdded\": false,\r\n\t\t\t \"comment\": \"Payment for order #123\",\r\n\t\t\t \"internalReference\": \"123\",\r\n\t\t\t \"reason\": \"Payment for order #123\"\r\n\t\t }\r\n\t ]\r\n }", "operationId": "OrdersAddPaymentToOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the existing order. (Required)", "required": true, "schema": { "type": "string", "description": "The ID of the existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "A list of payments to add to the order. (Required)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The payments were added to the order, and the updated order is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "The order ID or payments are invalid.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The order does not exist.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while adding payments to the order.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "deprecated": true }, "post": { "tags": [ "Orders | Payments" ], "summary": "Add new payments to an existing order. Will overwrite payments with matching Id, and add payments where no exiting payment with matching Id exists. NB! Payments with Id null will always be appended to payment list.", "description": " Sample request for adding payments to an order:\r\n\r\n POST /api/orders/EPIC000001/AddPayments\r\n {\r\n\t \"payments\": [\r\n\t\t {\r\n\t\t\t \"amount\": 100.0,\r\n\t\t\t \"authorizationCode\": \"123456\",\r\n\t\t\t \"customerName\": \"John Doe\",\r\n\t\t\t \"id\": \"abc123\",\r\n\t\t \t \"paymentMethodName\": \"Klarna\",\r\n\t\t \t \"paymentType\": \"Invoice\",\r\n\t\t \t \"status\": \"Processed\",\r\n\t\t \t\"transactionId\": \"xyz789\",\r\n\t\t \t\"transactionType\": \"Authorization\",\r\n\t\t \t\"properties\": [\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property1\",\r\n\t\t\t \t\t \"value\": \"Value1\"\r\n\t\t\t \t },\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property2\",\r\n\t\t\t \t\t \"value\": \"Value2\"\r\n\t\t\t \t }\r\n\t\t \t ],\r\n\t\t\t \"paidDate\": \"2021-10-01T00:00:00Z\",\r\n\t\t\t \"created\": \"2021-09-01T00:00:00Z\",\r\n\t\t\t \"isManuallyAdded\": false,\r\n\t\t\t \"comment\": \"Payment for order #123\",\r\n\t\t\t \"internalReference\": \"123\",\r\n\t\t\t \"reason\": \"Payment for order #123\"\r\n\t\t }\r\n\t ]\r\n }", "operationId": "OrdersAddPayments", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the existing order. (Required)", "required": true, "schema": { "type": "string", "description": "The ID of the existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "A list of payments to add to the order. (Required)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to add to the order. (Required)" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The payments were added to the order, and the updated order is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "The order ID or payments are invalid.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The order does not exist.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while adding payments to the order.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Orders/{orderId}/PutPayments": { "put": { "tags": [ "Orders | Payments" ], "summary": "Set payments on an existing order. Will overwrite full list of payments", "description": " Sample request for setting payments to an order:\r\n\r\n PUT /api/orders/EPIC000001/PutPayments\r\n {\r\n\t \"payments\": [\r\n\t\t {\r\n\t\t\t \"amount\": 100.0,\r\n\t\t\t \"authorizationCode\": \"123456\",\r\n\t\t\t \"customerName\": \"John Doe\",\r\n\t\t\t \"id\": \"abc123\",\r\n\t\t \t \"paymentMethodName\": \"Klarna\",\r\n\t\t \t \"paymentType\": \"Invoice\",\r\n\t\t \t \"status\": \"Processed\",\r\n\t\t \t\"transactionId\": \"xyz789\",\r\n\t\t \t\"transactionType\": \"Authorization\",\r\n\t\t \t\"properties\": [\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property1\",\r\n\t\t\t \t\t \"value\": \"Value1\"\r\n\t\t\t \t },\r\n\t\t\t \t {\r\n\t\t\t \t\t \"key\": \"Property2\",\r\n\t\t\t \t\t \"value\": \"Value2\"\r\n\t\t\t \t }\r\n\t\t \t ],\r\n\t\t\t \"paidDate\": \"2021-10-01T00:00:00Z\",\r\n\t\t\t \"created\": \"2021-09-01T00:00:00Z\",\r\n\t\t\t \"isManuallyAdded\": false,\r\n\t\t\t \"comment\": \"Payment for order #123\",\r\n\t\t\t \"internalReference\": \"123\",\r\n\t\t\t \"reason\": \"Payment for order #123\"\r\n\t\t }\r\n\t ]\r\n }", "operationId": "OrdersPutPaymentsOnOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the existing order. (Required)", "required": true, "schema": { "type": "string", "description": "The ID of the existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "A list of payments to set on the order. (Required)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to set on the order. (Required)" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to set on the order. (Required)" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to set on the order. (Required)" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "A list of payments to set on the order. (Required)" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The payments were set on the order.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "The order ID or payments are invalid.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The order does not exist.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while adding payments to the order.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Orders/{id}/GetPaymentOptions": { "get": { "tags": [ "Orders | Payments" ], "summary": "Get valid payment options for a order.", "description": "Based on order market, this will return valid payment options. If order has storeId we will also filter on store", "operationId": "OrdersGetPaymentOptions", "parameters": [ { "name": "id", "in": "path", "description": "Order id", "required": true, "schema": { "type": "string", "description": "Order id", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "A list of payment options", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOption" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order or payment options not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/PatchOrder": { "patch": { "tags": [ "Orders | Update" ], "summary": "Patch Order - update only values in request", "operationId": "OrdersPatchOrder", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of existing order. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "Order patches. Properties with value will be updated", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } } } }, "400": { "description": "Order patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Orders/{orderId}/PatchUpdateOrderLines": { "patch": { "tags": [ "Orders | Order Lines" ], "summary": "Patch OrderLines - update only values in request", "description": "Sample request for patching order line with lineItemId \"1\". Updating color and placedPrice.\r\n \r\n PATCH /api/{orderId}/patchUpdateOrderLines\r\n {\r\n [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"color\" : \"blue\",\r\n \"placedPrice\": 100\r\n }\r\n ]\r\n }", "operationId": "OrdersPatchOrderLine", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of existing order. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "OrderLine patches. OrderLine with value will be updated. LineItemId is required", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "OrderLine patches. OrderLine with value will be updated. LineItemId is required", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "OrderLine patches. OrderLine with value will be updated. LineItemId is required", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "OrderLine patches. OrderLine with value will be updated. LineItemId is required", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "OrderLine patches. OrderLine with value will be updated. LineItemId is required", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "OrderLines updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderLineUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLineUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLineUpdateResult" } } } }, "400": { "description": "OrderLines patch are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/OrderLines/{lineItemId}/Cancel": { "post": { "tags": [ "Orders | Order Lines" ], "summary": "Cancel order line", "operationId": "OrdersCancelOrderLine", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID (Required)", "required": true, "schema": { "type": "string", "description": "Order ID (Required)", "nullable": true } }, { "name": "lineItemId", "in": "path", "description": "Order line ID (Required)", "required": true, "schema": { "type": "string", "description": "Order line ID (Required)", "nullable": true } }, { "name": "sendNotifications", "in": "query", "description": "If true, notification about cancellation is sent to customer", "schema": { "type": "boolean", "description": "If true, notification about cancellation is sent to customer" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order line cancelled successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "Order line was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Order line could not be cancelled", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/OrderLines/Cancel": { "post": { "tags": [ "Orders | Order Lines" ], "summary": "Cancel order lines (100 orders limit)", "operationId": "OrdersCancelOrderLines", "parameters": [ { "name": "sendNotifications", "in": "query", "description": "If true, notification about cancellation is sent to customer", "schema": { "type": "boolean", "description": "If true, notification about cancellation is sent to customer" } } ], "requestBody": { "description": "List of orderLineIdRequests with cancellations", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineIdRequest" }, "description": "List of orderLineIdRequests with cancellations", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineIdRequest" }, "description": "List of orderLineIdRequests with cancellations", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineIdRequest" }, "description": "List of orderLineIdRequests with cancellations", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineIdRequest" }, "description": "List of orderLineIdRequests with cancellations", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order lines cancelled successfully", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Order lines could not be cancelled", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/OrderLines": { "post": { "tags": [ "Orders | Order Lines" ], "summary": "Add order line", "operationId": "OrdersAddOrderLine", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID (Required)", "required": true, "schema": { "type": "string", "description": "Order ID (Required)", "nullable": true } }, { "name": "shipmentId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderLine" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order line added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "Order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Order line could not be added", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/AddManyOrderLines": { "post": { "tags": [ "Orders | Order Lines" ], "summary": "Add many order lines", "operationId": "OrdersAddManyOrderLines", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID (Required)", "required": true, "schema": { "type": "string", "description": "Order ID (Required)", "nullable": true } }, { "name": "shipmentId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order line added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "Order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Order line could not be added", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/AddOrderLineProperties": { "put": { "tags": [ "Orders | Order Lines" ], "summary": "Add or update properties on order lines", "description": "Sample request:\r\n \r\n PUT /api/orders/EPIC000001/AddOrderLineProperties\r\n [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"properties\": [\r\n {\r\n \"key\": \"color\",\r\n \"value\": \"red\"\r\n },\r\n {\r\n \"key\": \"size\",\r\n \"value\": \"medium\"\r\n }\r\n ]\r\n },\r\n {\r\n \"lineItemId\": \"2\",\r\n \"properties\": [\r\n {\r\n \"key\": \"color\",\r\n \"value\": \"blue\"\r\n },\r\n {\r\n \"key\": \"size\",\r\n \"value\": \"large\"\r\n }\r\n ]\r\n }\r\n ]", "operationId": "OrdersAddOrderLineProperties", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of existing order. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing order. (Required)", "nullable": true } } ], "requestBody": { "description": "OrderLineId and List of properties to add or update.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemPropertiesPatch" }, "description": "OrderLineId and List of properties to add or update." } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemPropertiesPatch" }, "description": "OrderLineId and List of properties to add or update." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemPropertiesPatch" }, "description": "OrderLineId and List of properties to add or update." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemPropertiesPatch" }, "description": "OrderLineId and List of properties to add or update." } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Order lines updated with properties", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Missing order lines or missing patch request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Could not update lineItem properties", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}/Return": { "post": { "tags": [ "Obsolete" ], "summary": "Create a return with all or some of the line items. Will also credit payment.", "operationId": "OrdersReturn", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "description": "The ID of the order", "nullable": true } } ], "requestBody": { "description": "List of items to return. StoreId for return and userId", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } }, "deprecated": true } }, "/api/Orders/{id}": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a single order", "operationId": "OrdersGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of the order to return", "required": true, "schema": { "type": "string", "description": "ID of the order to return", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "The order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{id}/{versionId}": { "get": { "tags": [ "Orders | Get" ], "summary": "Get specific order version", "operationId": "OrderGetVersion", "parameters": [ { "name": "id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "string", "description": "Order ID", "nullable": true } }, { "name": "versionId", "in": "path", "description": "Version ID to fetch", "required": true, "schema": { "type": "string", "description": "Version ID to fetch", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumVersion" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/carts/{cartId}": { "get": { "tags": [ "Orders | Others" ], "summary": "Returns a single order which has a matching cartId property.", "operationId": "OrdersGetByCartId", "parameters": [ { "name": "cartId", "in": "path", "description": "ID of the cart the order originated from", "required": true, "schema": { "type": "string", "description": "ID of the cart the order originated from", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "The order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/secret/{secretKey}": { "get": { "tags": [ "Orders | Others" ], "summary": "Returns a single order which has a matching secretKey property.", "operationId": "OrdersGetBySecretKey", "parameters": [ { "name": "secretKey", "in": "path", "description": "The secret key of the order", "required": true, "schema": { "type": "string", "description": "The secret key of the order", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "404": { "description": "The order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrders/Count": { "get": { "tags": [ "Orders | Others" ], "summary": "Returns the number of orders for a given status and given store.", "description": "Sample request:\r\n GET /api/orders/GetOrders/Count?storeId=123&status=New&changedSince=2022-01-01T00:00:00Z", "operationId": "OrdersGetOrderCount", "parameters": [ { "name": "storeId", "in": "query", "description": "ID for a store", "schema": { "type": "array", "items": { "type": "string" }, "description": "ID for a store", "nullable": true } }, { "name": "status", "in": "query", "description": "Filter on order status. Possible values: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped, Returned, PartiallyReturned.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on order status. Possible values: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped, Returned, PartiallyReturned.", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Filter on changed date(UTC)", "schema": { "type": "string", "description": "Filter on changed date(UTC)", "format": "date-time" } }, { "name": "orderTypes", "in": "query", "description": "Filter on order types: Online, Pos, ClickAndCollect etc.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on order types: Online, Pos, ClickAndCollect etc.", "nullable": true } }, { "name": "filterOnWarehouse", "in": "query", "description": "Filter on shipment warehouse. If false, storefilter will be order.storeId", "schema": { "type": "boolean", "description": "Filter on shipment warehouse. If false, storefilter will be order.storeId" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The number of orders for a given status and store", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } }, "application/json": { "schema": { "type": "integer", "format": "int32" } }, "text/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrders": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a list of orders, support paging", "operationId": "OrdersGetOrders", "parameters": [ { "name": "storeId", "in": "query", "description": "ID for a store", "schema": { "type": "array", "items": { "type": "string" }, "description": "ID for a store", "nullable": true } }, { "name": "status", "in": "query", "description": "Filter on status: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped,Returned, PartiallyReturned", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on status: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped,Returned, PartiallyReturned", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Filter on changed date(UTC)", "schema": { "type": "string", "description": "Filter on changed date(UTC)", "format": "date-time" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.(default is 20)", "schema": { "type": "integer", "description": "Max 100. Minimum 1.(default is 20)", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrders/ByOrderType": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a list of orders filtered by order type, with support for paging.", "description": "Sample request for getting orders with order type \"Online\" and status \"New\" from store \"123\" that has changed since 2022-01-01T00:00:00Z\r\n \r\n GET /api/orders/GetOrders/ByOrderType?storeId=123&status=New&orderTypes=Online&changedSince=2022-01-01T00:00:00Z&page=1&pageSize=20", "operationId": "OrdersGetOrdersByOrderType", "parameters": [ { "name": "storeId", "in": "query", "description": "ID for a store", "schema": { "type": "array", "items": { "type": "string" }, "description": "ID for a store", "nullable": true } }, { "name": "status", "in": "query", "description": "Filter on order status. Possible values: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped, Returned, PartiallyReturned.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on order status. Possible values: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped, Returned, PartiallyReturned.", "nullable": true } }, { "name": "orderTypes", "in": "query", "description": "Filter on order type. Possible values: Online, POS, etc.", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on order type. Possible values: Online, POS, etc.", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Filter on changed date(UTC)", "schema": { "type": "string", "description": "Filter on changed date(UTC)", "format": "date-time" } }, { "name": "pageSize", "in": "query", "description": "Maximum number of results per page. Minimum 1, maximum 100 (default is 20).", "schema": { "type": "integer", "description": "Maximum number of results per page. Minimum 1, maximum 100 (default is 20).", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrdersForPickUpPoint": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a list of orders, filtered by shipment pick-up point", "operationId": "OrdersGetOrdersForPickUpPoint", "parameters": [ { "name": "storeId", "in": "query", "description": "ID for a store", "schema": { "type": "array", "items": { "type": "string" }, "description": "ID for a store", "nullable": true } }, { "name": "status", "in": "query", "description": "Filter on status: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped,Returned, PartiallyReturned", "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter on status: New, InTransit, InProgress, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped,Returned, PartiallyReturned", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Filter on changed date(UTC)", "schema": { "type": "string", "description": "Filter on changed date(UTC)", "format": "date-time" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.(default is 20)", "schema": { "type": "integer", "description": "Max 100. Minimum 1.(default is 20)", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrders/ByIds": { "get": { "tags": [ "Orders | Update" ], "summary": "Get multiple orders by IDs", "operationId": "OrdersGetOrdersByIds", "parameters": [ { "name": "ids", "in": "query", "description": "List of orders IDs which will be used to fetch corresponding orders", "schema": { "type": "array", "items": { "type": "string" }, "description": "List of orders IDs which will be used to fetch corresponding orders", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumGetMultipleResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGetMultipleResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGetMultipleResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "No orders were found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Search": { "post": { "tags": [ "Orders | Search" ], "summary": "Search and filtering of orders.", "operationId": "OrdersSearchOrders", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Scroll": { "post": { "tags": [ "Orders | Search" ], "summary": "Scroll orders by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.\r\n Sample request for a delta query using modified date and filtering on an order type:\r\n \r\n POST /api/orders/scroll\r\n {\r\n \"ModifiedFrom\": \"2022-12-24T17:32:28Z\",\r\n \"OrderType\": \"ClickAndCollect\"\r\n }", "operationId": "OrdersScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning orders", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Scroll/{id}": { "get": { "tags": [ "Orders | Search" ], "summary": "Scroll orders is used to get a large amount of orders.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "OrdersScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumResult" } } } } } } }, "/api/Orders/SearchByCustomProperties": { "post": { "tags": [ "Orders | Search" ], "summary": "Search orders by custom properties.", "operationId": "OrdersGetOrdersByCustomProperties", "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "value", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Orders were not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrdersForCustomer": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a list of orders for a given customer. Search by id, phone or e-mail. Supports paging.", "operationId": "OrdersGetOrdersForCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "ID of the customer", "schema": { "type": "string", "description": "ID of the customer", "nullable": true } }, { "name": "phone", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "email", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "storeId", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 100 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Orders were not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Customers/{customerId}/Orders": { "get": { "tags": [ "Orders | Get" ], "summary": "Returns a list of orders for a given customer. Supports paging.", "operationId": "OrdersGetOrdersByCustomerId", "parameters": [ { "name": "customerId", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 100 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Orders were not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/Customers/{customerId}/Orders/Search": { "post": { "tags": [ "Orders | Search" ], "summary": "Returns a list of orders for a given customer, matching search text. Supports paging.", "operationId": "OrdersSearchOrdersForCustomer", "parameters": [ { "name": "customerId", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Search request containing search query", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Orders were not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetOrderForCustomer": { "get": { "tags": [ "Orders | Get" ], "summary": "Get order for a single customer", "operationId": "OrdersGetOrderForCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "The id of the customer", "schema": { "type": "string", "description": "The id of the customer", "nullable": true } }, { "name": "orderId", "in": "query", "description": "The id of the order", "schema": { "type": "string", "description": "The id of the order", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/GetAsPdf/{orderId}": { "get": { "tags": [ "Orders | Others" ], "summary": "Get copy of receipt or template specific pdf", "operationId": "OrdersGetAsPdf", "parameters": [ { "name": "orderId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "templateFile", "in": "query", "description": "Used if you want template specific design. If template exist in subfolder, specify folder and file. eg: folderName/templateDesign.json", "schema": { "type": "string", "description": "Used if you want template specific design. If template exist in subfolder, specify folder and file. eg: folderName/templateDesign.json", "nullable": true } }, { "name": "shipmentId", "in": "query", "description": "Used only when templateFile is specified. If no shipmentId, all shipments will be included in print", "schema": { "type": "string", "description": "Used only when templateFile is specified. If no shipmentId, all shipments will be included in print", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "application/pdf": { "schema": { "type": "file" } }, "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/pdf": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order was not found", "content": { "application/pdf": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/pdf": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{orderId}": { "delete": { "tags": [ "Orders | Update" ], "summary": "Deletes an order from the OMS. Soft delete is default (order status will be set to \"deleted\").", "operationId": "OrdersDelete", "parameters": [ { "name": "orderId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "deletePermanently", "in": "query", "description": "If true, the order will be permanently deleted. No way back!", "schema": { "type": "boolean", "description": "If true, the order will be permanently deleted. No way back!", "default": false } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order to delete was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/{id}/Exists": { "head": { "tags": [ "Orders | Others" ], "summary": "Check if an order exists in Omnium", "operationId": "OrdersExists", "parameters": [ { "name": "id", "in": "path", "description": "ID of the order", "required": true, "schema": { "type": "string", "description": "ID of the order", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "The order was found in Omnium" }, "404": { "description": "The order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/ExistMany": { "post": { "tags": [ "Orders | Others" ], "summary": "Check if multiple orders exist in Omnium. Returns the IDs that were found.", "operationId": "OrdersExistMany", "requestBody": { "description": "List of order IDs to check (max 1000)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "List of order IDs to check (max 1000)", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "List of order IDs to check (max 1000)", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "List of order IDs to check (max 1000)", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "List of order IDs to check (max 1000)", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returns a list of IDs that exist in Omnium", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "The request was invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/AddComment": { "post": { "tags": [ "Orders | Others" ], "summary": "Add a comment to an order, with the option to send SMS, email or both", "description": "Sample request for adding a public comment with email notification:\r\n \r\n POST /api/Orders/AddComment\r\n {\r\n \"OrderId\": \"ORD-12345\",\r\n \"CommentType\": \"Public\",\r\n \"CommentText\": \"Hi! This is just a sample text.\",\r\n \"SendEmail\": true,\r\n \"EmailSubject\": \"Something order related\",\r\n \"EmailTo\": \"customer@example.com\",\r\n \"EmailFrom\": \"orders@yourcompany.com\",\r\n \"SenderName\": \"Order Team\"\r\n }\r\n \r\nSample request for adding a public comment with SMS notification:\r\n \r\n POST /api/Orders/AddComment\r\n {\r\n \"OrderId\": \"ORD-12345\",\r\n \"CommentType\": \"Public\",\r\n \"CommentText\": \"Hi there! This is an SMS message for you ❤️\",\r\n \"SendSms\": true,\r\n \"SmsPhoneNumber\": \"+4712345678\"\r\n }\r\n \r\nSample request for adding an internal comment (staff only):\r\n \r\n POST /api/Orders/AddComment\r\n {\r\n \"OrderId\": \"ORD-12345\",\r\n \"CommentType\": \"Internal\",\r\n \"CommentText\": \"Customer called about delivery delay.\",\r\n \"CreatedBy\": \"Support Team\"\r\n }\r\n \r\nNotes:\r\n- CommentType defaults to \"Public\" if not specified. CreatedBy defaults to the current API user's username if not specified.\r\n- EmailTo, EmailFrom, SenderName, and SmsPhoneNumber will fall back to the store's (or global) default settings in Omnium if not specified.\r\n- EmailTo falls back to the order's customer email. SmsPhoneNumber falls back to the order's customer phone.", "operationId": "OrdersAddComment", "requestBody": { "description": "The comment request containing order ID, comment type, text, and notification settings", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderCommentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderCommentRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Comment added successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/ExportOrders": { "post": { "tags": [ "Orders | Others" ], "summary": "Export orders to a connector", "description": "Sample request for exporting orders to a connector:\r\n \r\n POST /api/Orders/ExportOrders\r\n {\r\n \"connectorId\": \"19527b9b-6ebf-4d34-8e32-28ff618ff168\",\r\n \"orderIds\": [\"ORDER-001\", \"ORDER-002\", \"ORDER-003\"]\r\n }\r\n\r\n POST /api/Orders/ExportOrders\r\n {\r\n \"connectorName\": \"Shopify\",\r\n \"orderIds\": [\"1213\", \"1214\", \"1214\"]\r\n }\r\n \r\nIf both connectorId and connectorName is provided, we will prioritize connectorId as it is more specific.\r\n///", "operationId": "OrdersExportOrders", "requestBody": { "description": "The export request containing connector ID and list of order IDs to export", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderExportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderExportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderExportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumOrderExportRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Orders exported successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportResult" } } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "One or more orders not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error occurred during export", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/PatchLineItemIds": { "post": { "tags": [ "Orders | Others" ], "summary": "Patch line item IDs across order form, shipments, and return order forms", "description": "Sample request for updating line item IDs:\r\n \r\n POST /api/Orders/PatchLineItemIds\r\n {\r\n \"orderId\": \"ORDER-001\",\r\n \"lineItemIdMappings\": [\r\n {\r\n \"oldLineItemId\": \"old-line-1\",\r\n \"newLineItemId\": \"new-line-1\"\r\n },\r\n {\r\n \"oldLineItemId\": \"old-line-2\",\r\n \"newLineItemId\": \"new-line-2\"\r\n }\r\n ]\r\n }\r\n \r\nThis endpoint will update line item IDs in:\r\n- order.OrderForm.LineItems\r\n- order.OrderForm.Shipments[].LineItems\r\n- order.ReturnOrderForms[].LineItems", "operationId": "OrdersPatchLineItemIds", "requestBody": { "description": "The request containing order ID and line item ID mappings", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Line item IDs updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPatchLineItemIdsResult" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error occurred during update", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PaymentReport": { "post": { "tags": [ "Orders | Payments" ], "summary": "Get payment report with payment transactions", "operationId": "PaymentReportSearchPaymentTransactions", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning payment transactions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPaymentTransactionOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentTransactionOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentTransactionOmniumSearchResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PaymentReport/SearchPaymentTransactionsByDateAndPaymentMethod": { "post": { "tags": [ "Orders | Payments" ], "summary": "Get payment report aggregated by date, store and payment method", "operationId": "PaymentReportSearchPaymentTransactionsByDateAndPaymentMethod", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentReportSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning payment transactions", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPaymentSummaryOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentSummaryOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPaymentSummaryOmniumSearchResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PickList/Search": { "post": { "tags": [ "Orders | Pick Lists" ], "summary": "Search all PickLists.", "description": "Search pickLists.", "operationId": "PickListSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPickListSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPickListSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPickListOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListOmniumSearchResult" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PickList/Get": { "get": { "tags": [ "Orders | Pick Lists" ], "summary": "Get PickList with id.", "description": "Get pickList.", "operationId": "PickListGet", "parameters": [ { "name": "id", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PickList/PatchPickList": { "patch": { "tags": [ "Orders | Pick Lists" ], "summary": "Patch PickList - update only values in request.", "description": "Patch pickLists.", "operationId": "PickListPatchPickList", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPickListPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPickListPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPickListPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPickList" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceListItems/Search": { "post": { "tags": [ "Products | Price List Items" ], "summary": "Search price list items", "operationId": "PriceListItemsSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceListItems/ScrollSearch": { "post": { "tags": [ "Products | Price List Items" ], "summary": "Scroll price list items using available parameters in OmniumPriceListItemSearchRequest.", "description": "Notice that the 'scrollId' property has been populated as totalHits exceeds 1000, meaning that you should use the scroll endpoint to fetch remaining prices list items\r\n \r\n {\r\n \"totalHits\": 41244,\r\n \"result\": [\r\n {\r\n \"priceListId\": \"...\",\r\n \"skuId\": \"SKU12345678\",\r\n ...\r\n },\r\n {\r\n \"marketId: \"NOR\",\r\n ...\r\n }\r\n ],\r\n \"scrollId\": \"ifd42421406egc603b2c4f0d8b3ef60b\"\r\n }\r\n \r\n\r\nPlease note that if the total amount is larger than 1000 (or scrollSize if specified) , the response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.", "operationId": "PriceListItemsScrollSearch", "requestBody": { "description": "The PriceListItemSearchRequest contains properties for filtering prices", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning prices", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceListItems/Scroll/{id}": { "get": { "tags": [ "Products | Price List Items" ], "summary": "Scroll price list items is used to get a large amount of prices.", "description": "The scroll ID can be obtained from a standard search request that supports scrolling.\r\nScrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PriceListItemsScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemOmniumResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/{id}": { "get": { "tags": [ "Products | Price Lists" ], "summary": "Get price list", "operationId": "PriceListsGetPriceList", "parameters": [ { "name": "id", "in": "path", "description": "The id of the price list", "required": true, "schema": { "type": "string", "description": "The id of the price list" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Products | Price Lists" ], "summary": "Delete a price list and the corresponding price list items", "operationId": "PriceListsDeletePriceList", "parameters": [ { "name": "id", "in": "path", "description": "The id of the price list to delete", "required": true, "schema": { "type": "string", "description": "The id of the price list to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/PriceLists/SearchPriceLists": { "post": { "tags": [ "Products | Price Lists" ], "summary": "Search price lists", "operationId": "PriceListsSearchPriceLists", "requestBody": { "description": "Price list search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceListOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/PriceLists/AddPriceList": { "post": { "tags": [ "Products | Price Lists" ], "summary": "Add price list, if a priceList with the same ID already exists, it will be updated.", "operationId": "PriceListsAddPriceList", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/ActivatePriceList/{priceListId}": { "post": { "tags": [ "Products | Price Lists" ], "summary": "Activate price list. Will create product prices for all items in the price list.", "operationId": "PriceListsActivatePriceList", "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/DeactivatePriceList/{priceListId}": { "post": { "tags": [ "Products | Price Lists" ], "summary": "Deactivate price list. Will remove product prices for all items in the price list.", "operationId": "PriceListsDeactivatePriceList", "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/ValidatePriceList/{priceListId}": { "post": { "tags": [ "Products | Price Lists" ], "summary": "Enqueue a validation run for the price list. Validators configured for the tenant are run sequentially across all items,\r\nand per-item validation errors are persisted on each item's Errors list. Returns immediately with Status set to \"Validating\";\r\npoll GetPriceList to observe completion.", "operationId": "PriceListsValidatePriceList", "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceList" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/AddPriceListItems": { "post": { "tags": [ "Products | Price List Items" ], "summary": "Add or update priceListItems. PriceListId is required on the items. If the priceList does not exist, items will be ignored.", "operationId": "PriceListsAddPriceListItems", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/PatchPriceListItems": { "patch": { "tags": [ "Products | Price List Items" ], "summary": "Partially update price list items. Only non-null fields will be updated. Derived fields (DiscountedPrice, Profit, etc.) are recalculated automatically.\r\nItems that don't exist will be auto-created. The Id can be provided directly or derived from PriceListId + SkuId/ProductId.", "operationId": "PriceListsPatchPriceListItems", "parameters": [ { "name": "activatePriceLists", "in": "query", "description": "When true, affected price lists will be activated after patching (pushes prices to products). Default: false.", "schema": { "type": "boolean", "description": "When true, affected price lists will be activated after patching (pushes prices to products). Default: false.", "default": false } }, { "name": "enrichWithProductData", "in": "query", "description": "When true, product data (e.g. product name, cost price) will be fetched and stored on the price list items in the background.\r\n This can be used even when no price fields are changed in the patches — for example, to enrich existing items with product data without modifying prices.\r\n Note: the returned Omnium.Public.PriceLists.OmniumPriceListItemPatchUpdateResult will not contain the enriched product data; it is only persisted on the price list items in the background.", "schema": { "type": "boolean", "description": "When true, product data (e.g. product name, cost price) will be fetched and stored on the price list items in the background.\r\n This can be used even when no price fields are changed in the patches — for example, to enrich existing items with product data without modifying prices.\r\n Note: the returned Omnium.Public.PriceLists.OmniumPriceListItemPatchUpdateResult will not contain the enriched product data; it is only persisted on the price list items in the background.", "default": false } } ], "requestBody": { "description": "List of partial updates. Each patch must include the Id or PriceListId + SkuId/ProductId.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItemPatch" }, "description": "List of partial updates. Each patch must include the Id or PriceListId + SkuId/ProductId." } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItemPatch" }, "description": "List of partial updates. Each patch must include the Id or PriceListId + SkuId/ProductId." } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItemPatch" }, "description": "List of partial updates. Each patch must include the Id or PriceListId + SkuId/ProductId." } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItemPatch" }, "description": "List of partial updates. Each patch must include the Id or PriceListId + SkuId/ProductId." } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemPatchUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemPatchUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceListItemPatchUpdateResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PriceLists/{id}/priceListItems": { "get": { "tags": [ "Products | Price List Items" ], "summary": "Get price list items for a price list", "operationId": "PriceListsGetPriceListItems", "parameters": [ { "name": "id", "in": "path", "description": "The id of the price list", "required": true, "schema": { "type": "string", "description": "The id of the price list", "nullable": true } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer", "description": "Page number", "format": "int32", "default": 1 } }, { "name": "take", "in": "query", "description": "Number of elements", "schema": { "type": "integer", "description": "Number of elements", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/PriceLists/DeletePriceListItems": { "delete": { "tags": [ "Products | Price List Items" ], "summary": "Delete price list items", "operationId": "PriceListsDeletePriceListItems", "requestBody": { "description": "Ids of the price list items to delete", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of the price list items to delete", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of the price list items to delete", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of the price list items to delete", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of the price list items to delete", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/Prices/Scroll/{id}": { "get": { "tags": [ "Products | Prices" ], "summary": "Scroll prices is used to get a large amount of prices.", "description": "NB! Only to be used when price index is enabled for tenant. Send email to support@omnium.no if you need more information.\r\n
\r\n The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PricesScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceOmniumResult" }, "example": { "totalHits": 1, "result": [ { "marketId": "NOR", "code": "SKU12345678", "validFrom": "2020-01-01T00:00:00", "validUntil": "2020-02-01T00:00:00", "minQuantity": 0.0, "unitPrice": 900.0, "currencyCode": "NOK", "customerId": "C-123", "discountAmount": 100.0, "discountPercent": 10.0, "originalUnitPrice": 1000.0, "recommendedRetailPrice": 2000.0, "isTaxExcluded": false, "cost": 0.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "isValid": true } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/Prices/Search": { "post": { "tags": [ "Products | Prices" ], "summary": "Search prices using available parameters in OmniumPriceSearchRequest.", "description": "NB! Only to be used when price index is enabled for tenant. Send email to support@omnium.no if you need more information.\r\n
\r\n Sample request for a delta query:\r\n \r\n POST /api/prices/search\r\n {\r\n \"LastModified\": \"2019-11-21T17:32:28Z\"\r\n }\r\n \r\n Sample request for prices for a specific customer in one or more markets:\r\n \r\n POST /api/prices/search\r\n {\r\n \"CustomerId\": \"CU12345\",\r\n \"MarketIds\": [\"NOR\", \"SWE\"]\r\n }\r\n \r\n Sample request for prices valid at a specific point in time (set ValidFrom and ValidUntil to the same timestamp):\r\n \r\n POST /api/prices/search\r\n {\r\n \"ProductCodes\": [\"SKU12345678\"],\r\n \"ValidFrom\": \"2026-06-18T00:00:00Z\",\r\n \"ValidUntil\": \"2026-06-18T00:00:00Z\"\r\n }\r\n \r\n Samples response if the number of prices exceeds 1000 (totalHits).\r\n
\r\n Notice that the 'scrollId' property has been populated as totalHits exceeds 1000, meaning that you should use the scroll endpoint to fetch remaining prices\r\n \r\n {\r\n \"totalHits\": 41244,\r\n \"result\": [\r\n {\r\n \"marketId\": \"NOR\",\r\n \"code\": \"SKU12345678\",\r\n \"validFrom\": \"2020-01-01T00:00:00\",\r\n \"validUntil\": \"2020-02-01T00:00:00\",\r\n \"minQuantity\": 0,\r\n \"unitPrice\": 900,\r\n \"currencyCode\": \"NOK\",\r\n \"customerId\": \"C-123\",\r\n \"discountAmount\": 100,\r\n \"discountPercent\": 10,\r\n \"originalUnitPrice\": 1000,\r\n \"recommendedRetailPrice\": 2000\r\n },\r\n {\r\n \"marketId: \"NOR\",\r\n ...\r\n }\r\n ],\r\n \"scrollId\": \"2f842421e06e4c60bb2c4f0d8b3ef60b\"\r\n }\r\n \r\n \r\n Please note that if the total amount is larger than 1000 (or scrollSize if specified) , the response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.", "operationId": "PricesSearch", "requestBody": { "description": "The PriceSearchRequest contains properties for filtering prices", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceSearchRequest" }, "example": { "customerId": "C10001", "marketIds": [ "NOR" ], "productCodes": [ "SKU1001", "SKU1002", "SKU1003", "SKU1004", "SKU1005" ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceSearchRequest" }, "example": { "customerId": "C10001", "marketIds": [ "NOR" ], "productCodes": [ "SKU1001", "SKU1002", "SKU1003", "SKU1004", "SKU1005" ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceSearchRequest" }, "example": { "customerId": "C10001", "marketIds": [ "NOR" ], "productCodes": [ "SKU1001", "SKU1002", "SKU1003", "SKU1004", "SKU1005" ] } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPriceSearchRequest" }, "example": { "customerId": "C10001", "marketIds": [ "NOR" ], "productCodes": [ "SKU1001", "SKU1002", "SKU1003", "SKU1004", "SKU1005" ] } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning prices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPriceOmniumResult" }, "example": { "totalHits": 1, "result": [ { "marketId": "NOR", "code": "SKU12345678", "validFrom": "2020-01-01T00:00:00", "validUntil": "2020-02-01T00:00:00", "minQuantity": 0.0, "unitPrice": 900.0, "currencyCode": "NOK", "customerId": "C-123", "discountAmount": 100.0, "discountPercent": 10.0, "originalUnitPrice": 1000.0, "recommendedRetailPrice": 2000.0, "isTaxExcluded": false, "cost": 0.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "isValid": true } } } }, "400": { "description": "Search request invalid", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/api/Prices/AddMany": { "put": { "tags": [ "Products | Prices" ], "summary": "Put one or more prices to a product in Omnium. Will overwrite existing price if found, or add a new price if no match is found.\r\nThe price is identified by checking CustomerId, CustomerGroup, VariantId, MarketId, MarketGroupId, CurrencyCode, SalesCode, PromotionId, StoreId, and PriceListId.\r\nIf IgnoreDates is false, dates are also considered when fetching existing prices.\r\n
By default (PricesMergeMode = Replace) a matched price is overwritten in full, so fields you do not send are reset to their defaults.\r\nSet PricesMergeMode to AddOrUpdate or UpdateOnly to only apply the fields you send and keep the existing values for the rest. See OmniumPriceUpdateRequest.PricesMergeMode for details.", "operationId": "PricesPutPrices", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceUpdateRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceUpdateRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceUpdateRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceUpdateRequest" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" } } } }, "/api/Prices": { "delete": { "tags": [ "Products | Prices" ], "summary": "Delete one or more prices on a product in Omnium. Will delete existing price if found.", "operationId": "PricesDeletePrices", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceDeleteRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceDeleteRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceDeleteRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceDeleteRequest" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" } } } }, "/api/PrivateCustomers": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add a private customer customer to database.", "operationId": "PrivateCustomersPost", "requestBody": { "description": "The customer object to be stored in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/AddMany": { "post": { "tags": [ "Customers | B2C" ], "summary": "Adds a range of new customers to the OMS.\r\nOnly not existing customers will be added(based on customerId)\r\nMax size in batch is 100", "operationId": "PrivateCustomersAddMany", "parameters": [ { "name": "exportCustomers", "in": "query", "description": "If true - Omnium will trigger configured connectors to export updated customers", "schema": { "type": "boolean", "description": "If true - Omnium will trigger configured connectors to export updated customers", "default": false, "nullable": true } } ], "requestBody": { "description": "A list of privateCustomers objects that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/AddOrUpdateMany": { "put": { "tags": [ "Customers | B2C" ], "summary": "Add or update a range of customers to the OMS.\r\nMax size in batch is 100", "operationId": "PrivateCustomersAddOrUpdateMany", "parameters": [ { "name": "exportCustomers", "in": "query", "description": "If true - Omnium will trigger configured connectors to export updated customers", "schema": { "type": "boolean", "description": "If true - Omnium will trigger configured connectors to export updated customers", "default": false, "nullable": true } } ], "requestBody": { "description": "A list of privateCustomers objects that needs to be added/updated to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added/updated to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added/updated to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added/updated to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "A list of privateCustomers objects that needs to be added/updated to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Update": { "post": { "tags": [ "Customers | B2C" ], "summary": "Update private customer", "operationId": "PrivateCustomersUpdate", "requestBody": { "description": "The customer object to be updated in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The customer to update was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/PatchPrivateCustomer": { "patch": { "tags": [ "Customers | B2C" ], "summary": "Patch private customer - update only some values in request", "operationId": "PrivateCustomersPatchPrivateCustomer", "requestBody": { "description": "Private customer patch. Only properties with value will be updated.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Private customer updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } } } }, "400": { "description": "Private customer patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while patching customer", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{customerId}": { "get": { "tags": [ "Customers | B2C" ], "summary": "Gets the specified customer identifier.", "operationId": "PrivateCustomersGet", "parameters": [ { "name": "customerId", "in": "path", "description": "The customer identifier.", "required": true, "schema": { "type": "string", "description": "The customer identifier.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning the customer", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } } } }, "404": { "description": "The customer, with the given customerId, was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/GetCustomerByPhoneAndStore": { "get": { "tags": [ "Customers | B2C" ], "summary": "Gets customer and related customer club membership info. Customer must have registered phone number and be connected to the specified store.", "operationId": "PrivateCustomersGetCustomerByPhoneAndStore", "parameters": [ { "name": "phoneNumber", "in": "query", "description": "The customers phone number.", "required": true, "schema": { "type": "string", "description": "The customers phone number." } }, { "name": "storeId", "in": "query", "description": "The store the customer is connected to.", "required": true, "schema": { "type": "string", "description": "The store the customer is connected to." } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning customer view model", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerViewModel" } } } }, "404": { "description": "No customer with given combo of store and phone number was found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Anonymize": { "delete": { "tags": [ "Customers | B2C" ], "summary": "Delete the private customer and anonymize all related orders, projects, and other data.", "operationId": "PrivateCustomersAnonymizeCustomer", "parameters": [ { "name": "id", "in": "query", "description": "ID of the customer to anonymize", "required": true, "schema": { "type": "string", "description": "ID of the customer to anonymize" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Anonymization successful, or customer is already anonymized" }, "400": { "description": "Anonymization failed usually if customer has open orders", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}": { "delete": { "tags": [ "Customers | B2C" ], "summary": "Delete the private customer.\r\nIf the customer is a contact person on any business customers, the relation will be deleted", "operationId": "PrivateCustomersDelete", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer to delete", "required": true, "schema": { "type": "string", "description": "ID of the customer to delete" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Private customer has been deleted" }, "404": { "description": "The customer with the given ID was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Information/{id}": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get all customer personal data, orders, and other data stored in the OMS.", "operationId": "PrivateCustomersGetPrivateCustomerInformation", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerInfo" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Consents": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add a new consent for the customer", "operationId": "PrivateCustomersAddConsent", "parameters": [ { "name": "customerId", "in": "query", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer" } } ], "requestBody": { "description": "The consent to be added", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumConsent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumConsent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumConsent" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumConsent" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The customer was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Consents/AddMany": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add consents for many customers in one call. For each customer, a consent of a new type is added and a consent\r\nof an existing type is updated (the previous value is kept in consent history). Changed customers are indexed in bulk.\r\nOnly existing customers are processed - unknown customers are skipped and returned in NotFoundIds. Max size in batch is 1000.", "operationId": "PrivateCustomersAddManyConsents", "parameters": [ { "name": "exportCustomers", "in": "query", "description": "If true - Omnium will trigger configured connectors to export updated customers", "schema": { "type": "boolean", "description": "If true - Omnium will trigger configured connectors to export updated customers", "default": false, "nullable": true } } ], "requestBody": { "description": "List of customers and the consents to add for each", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerConsents" }, "description": "List of customers and the consents to add for each", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerConsents" }, "description": "List of customers and the consents to add for each", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerConsents" }, "description": "List of customers and the consents to add for each", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerConsents" }, "description": "List of customers and the consents to add for each", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returns a summary of how many customers were updated, unchanged, and not found.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerUpdateResult" } } } }, "400": { "description": "Request is null, empty, or exceeds the batch limit", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "An error occurred while adding consents", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Consents/{id}": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get all consents for the customer.", "operationId": "PrivateCustomersGetConsentsForCustomer", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "A list of consents", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" } } } } }, "404": { "description": "The customer was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Search": { "get": { "tags": [ "Obsolete" ], "summary": "Search for private customers. Obsolete: Please use POST api/privateCustomers/search instead.", "operationId": "PrivateCustomerFreeTextSearch", "parameters": [ { "name": "query", "in": "query", "description": "Search query", "schema": { "type": "string", "description": "Search query", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } } } } }, "deprecated": true }, "post": { "tags": [ "Customers | B2C" ], "summary": "Search private customers", "operationId": "PrivateCustomersSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returns list of private customers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } } } } } } }, "/api/PrivateCustomers/GetAll": { "get": { "tags": [ "Obsolete" ], "summary": "Get all private customers", "operationId": "PrivateCustomersGetAll", "parameters": [ { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32" } }, { "name": "sortOrder", "in": "query", "description": "Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending", "schema": { "type": "string", "description": "Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending", "nullable": true } }, { "name": "changedSince", "in": "query", "description": "Customers added or modified since a given date and time", "schema": { "type": "string", "description": "Customers added or modified since a given date and time", "format": "date-time", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } } } } }, "deprecated": true } }, "/api/PrivateCustomers/Scroll": { "post": { "tags": [ "Customers | B2C" ], "summary": "Scroll privateCustomers by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.", "operationId": "PrivateCustomersScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning privateCustomers", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumSearchResult" } } } }, "400": { "description": "Search request invalid" } } } }, "/api/PrivateCustomers/Scroll/{id}": { "get": { "tags": [ "Customers | B2C" ], "summary": "Scroll privateCustomers is used to get a large amount of customers.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PrivateCustomersScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumResult" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get a customer club member", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersGetCustomerClubMember", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "404": { "description": "Customer club member was not found, or the membership is ended", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/Add": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add customer to customer club. Customer is created if not exist. This membership will be approved(consent by default)", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersAddNewCustomerClubMember", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "Could not create customer club member", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/AddPending": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add customer to customer club. Customer is created if not exist. Membership is not approved.\r\nTo be approved, update consents for this customer", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersAddNewPendingCustomerClubMember", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } }, { "name": "storeId", "in": "query", "description": "ID of the store the customer is coming from", "required": true, "schema": { "type": "string", "description": "ID of the store the customer is coming from" } }, { "name": "phone", "in": "query", "description": "Optional. If not set, id is used as phone", "schema": { "type": "string", "description": "Optional. If not set, id is used as phone", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "Could not create customer club member", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/AddWithConsents": { "post": { "tags": [ "Obsolete" ], "summary": "Add customer to customer club member with consents. Customer is created if not exist.", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.\r\n
\r\nUse: {id}/CustomerClubMember/AddWithConsentList instead.", "operationId": "PrivateCustomersAddNewCustomerClubMemberWithConsents", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Consents for this membership", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "Could not create customer club member", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "deprecated": true } }, "/api/PrivateCustomers/{id}/CustomerClubMember/AddWithConsentList": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add customer to customer club member with consents. Customer is created if not exist.", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersAddNewCustomerClubMemberWithConsentList", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } }, { "name": "salesPersonId", "in": "query", "description": "Id of the person who recruited the member", "schema": { "type": "string", "description": "Id of the person who recruited the member", "nullable": true } } ], "requestBody": { "description": "Consents for this membership. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "Could not create customer club member", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/UpdateConsents": { "post": { "tags": [ "Obsolete" ], "summary": "Update consents for customer club member", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.\r\n
\r\nUse: {id}/CustomerClubMember/UpdateConsentList instead.", "operationId": "PrivateCustomersUpdateCustomerClubMemberConsents", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Consents for this membership", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "404": { "description": "Club member not found, or customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "deprecated": true } }, "/api/PrivateCustomers/{id}/CustomerClubMember/UpdateConsentList": { "post": { "tags": [ "Customers | B2C" ], "summary": "Update consent list for customer club member", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersUpdateCustomerClubMemberConsentList", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Consents for this membership. This will update existing consents and add new. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. This will update existing consents and add new. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"" } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. This will update existing consents and add new. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"" } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. This will update existing consents and add new. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"" } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents for this membership. This will update existing consents and add new. Supported consent type: \"ApprovedConsents\", \"EmailMarketing\", \"SmsMarketing\"" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club object with summary", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Club member not found, or customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/AddWithPatchRequest": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add customer to customer club member with patch request, containing both consents, interests, and signUp storeId. Customer is created if not exist.", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersAddNewCustomerClubMemberWithPatch", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Consents and interests for this customer. StoreId can also be set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club member", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "CustomerClubMemberPatchRequest consents is required", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/UpdatedWithPatchRequest": { "post": { "tags": [ "Customers | B2C" ], "summary": "Update customer club member. Consents and interests will be updated/override with what you send in", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersUpdateCustomerClubMemberWithPatch", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "requestBody": { "description": "Consents, interests for this customer.StoreId can also be set. Will override existing", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberPatchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Customer club member", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "400": { "description": "CustomerClubMemberPatchRequest consents is required", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Club member not found, or customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/UpdateInterests": { "post": { "tags": [ "Customers | B2C" ], "summary": "Update list of interests for a customer club member. The list sent in, will replace existing(add or remove).\r\nSend in empty list(not null) if all interests should be removed", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersUpdateCustomerClubMemberInterests", "parameters": [ { "name": "id", "in": "path", "description": "Member id", "required": true, "schema": { "type": "string", "description": "Member id", "nullable": true } } ], "requestBody": { "description": "Interest to store, if customer has other interests, they will be deleted. Send in empty lists if all interests should be removed.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Interest to store, if customer has other interests, they will be deleted. Send in empty lists if all interests should be removed.", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Interest to store, if customer has other interests, they will be deleted. Send in empty lists if all interests should be removed.", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Interest to store, if customer has other interests, they will be deleted. Send in empty lists if all interests should be removed.", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Interest to store, if customer has other interests, they will be deleted. Send in empty lists if all interests should be removed.", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated customer club member", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } } } }, "404": { "description": "Club member not found, or customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/{id}/CustomerClubMember/Remove": { "delete": { "tags": [ "Customers | B2C" ], "summary": "Remove a customer from customer club", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersRemoveCustomerClubMember", "parameters": [ { "name": "id", "in": "path", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" }, "400": { "description": "Could not remove customer club member", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Club member not found, or customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Updated customer club member" } } } }, "/api/PrivateCustomers/AddOrUpdateManyCustomerClubMembers": { "put": { "tags": [ "Customers | B2C" ], "summary": "Add or update a range of CustomerClub members to the OMS.\r\nMax size in batch is 100\r\nUse this endpoint only for import or clean up. All existing points etc will be overridden with the input data\r\nPrivate customer objects will not be created. Use other endpoint for this", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersAddOrUpdateManyCustomerClubMembers", "requestBody": { "description": "A list of customerClubMembers objects that needs to be added/updated to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubMember" }, "description": "A list of customerClubMembers objects that needs to be added/updated to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubMember" }, "description": "A list of customerClubMembers objects that needs to be added/updated to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubMember" }, "description": "A list of customerClubMembers objects that needs to be added/updated to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubMember" }, "description": "A list of customerClubMembers objects that needs to be added/updated to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/GetAllCustomerClubMembers": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get all Customer club members", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersGetAllCustomerClubMembers", "parameters": [ { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 1000. Minimum 1.", "schema": { "type": "integer", "description": "Max 1000. Minimum 1.", "format": "int32" } }, { "name": "memberSince", "in": "query", "description": "Members since a given date and time", "schema": { "type": "string", "description": "Members since a given date and time", "format": "date-time", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } } } } } } }, "/api/PrivateCustomers/CustomerClubMembers/Search": { "post": { "tags": [ "Customers | B2C" ], "summary": "Search for customerClubMembers.", "operationId": "CustomerClubMembersSearch", "requestBody": { "description": "Search request object.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/PrivateCustomers/ScrollCustomerClubMembers/{id}": { "get": { "tags": [ "Customers | B2C" ], "summary": "Scroll customerClubMembers is used to get a large amount of customerClubMember items.", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.\r\n
\r\n The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PrivateCustomersScrollCustomerClubMembers", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerClubMemberOmniumResult" } } } } } } }, "/api/PrivateCustomers/GetCustomerClubInterests": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get available CustomerClub interests. Used to segment users and marketing", "description": "NB! Only to be used when customer club is enabled/added to the license for tenant. Send email to support@omnium.no if you need more information.", "operationId": "PrivateCustomersGetCustomerClubInterests", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "List of interests", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubInterests" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubInterests" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubInterests" } } } } }, "400": { "description": "Customer club is not defined", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Interests not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/UpdateCustomerNumber": { "post": { "tags": [ "Customers | B2C" ], "summary": "Update customer number on customer and all orders", "operationId": "PrivateCustomersUpdateCustomerNumber", "parameters": [ { "name": "customerId", "in": "query", "description": "ID of the customer", "required": true, "schema": { "type": "string", "description": "ID of the customer" } }, { "name": "customerNumber", "in": "query", "description": "The new customer number to be added", "required": true, "schema": { "type": "string", "description": "The new customer number to be added" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The customer was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/GetNextCustomerNumber": { "get": { "tags": [ "Customers | B2C" ], "summary": "Get next generated customer number.", "description": "Requires that CustomerNumberOptions is configured, with auto create enabled.", "operationId": "PrivateCustomersGetNextCustomerNumber", "parameters": [ { "name": "marketId", "in": "query", "description": "Optional: Provide if multiple CustomerNumberOptions configured", "schema": { "type": "string", "description": "Optional: Provide if multiple CustomerNumberOptions configured", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "CustomerNumber" }, "400": { "description": "CustomerNumber not available", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "NumberOptions not configured", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/AddComment": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add a comment to a customer", "description": "Sample request for adding a comment without notifications:\r\n \r\n POST /api/PrivateCustomers/AddComment\r\n {\r\n \"CustomerId\": \"customer@example.com\",\r\n \"CommentText\": \"Customer requested a callback regarding their recent order.\",\r\n \"CreatedBy\": \"CRM System\"\r\n }\r\n \r\nSample request for adding a comment with email notification:\r\n \r\n POST /api/PrivateCustomers/AddComment\r\n {\r\n \"CustomerId\": \"customer@example.com\",\r\n \"CommentText\": \"Thank you for contacting us. We have received your inquiry and will respond shortly.\",\r\n \"SendEmail\": true,\r\n \"EmailSubject\": \"Inquiry Received\",\r\n \"EmailTo\": \"customer@example.com\",\r\n \"EmailFrom\": \"support@yourcompany.com\",\r\n \"SenderName\": \"Customer Support\"\r\n }\r\n \r\nSample request for adding a comment with SMS notification:\r\n \r\n POST /api/PrivateCustomers/AddComment\r\n {\r\n \"CustomerId\": \"customer@example.com\",\r\n \"CommentText\": \"Your order has been shipped and will arrive within 2-3 business days.\",\r\n \"SendSms\": true,\r\n \"SmsPhoneNumber\": \"+4712345678\"\r\n }\r\n \r\nNotes:\r\n- CreatedBy defaults to the current API user's username if not specified.\r\n- EmailTo, EmailFrom, SenderName, and SmsPhoneNumber will fall back to the store's (or global) default settings in Omnium if not specified.\r\n- EmailTo falls back to the customer's email. SmsPhoneNumber falls back to the customer's phone.", "operationId": "PrivateCustomersAddComment", "requestBody": { "description": "The comment request containing customer ID, comment text, and notification settings", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Comment added successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/AddInternalComment": { "post": { "tags": [ "Customers | B2C" ], "summary": "Add an internal comment to a customer", "description": "Internal comments are only visible to Omnium users (not the customer).\r\nIf CreatedBy is not set, api user will be added as creator\r\n \r\nSample request for adding an internal comment without notifications:\r\n \r\n POST /api/PrivateCustomers/AddInternalComment\r\n {\r\n \"CustomerId\": \"customer@example.com\",\r\n \"CommentText\": \"Customer called about delayed shipment. Promised to investigate.\"\r\n }\r\n \r\nSample request for adding an internal comment with email notification:\r\n \r\n POST /api/PrivateCustomers/AddInternalComment\r\n {\r\n \"CustomerId\": \"customer@example.com\",\r\n \"CommentText\": \"Internal note regarding customer inquiry\",\r\n \"SendEmail\": true,\r\n \"EmailSubject\": \"Internal: Customer Follow-up Required\",\r\n \"EmailTo\": \"support@yourcompany.com\"\r\n }", "operationId": "PrivateCustomersAddInternalComment", "requestBody": { "description": "The comment request containing customer ID, comment text, and notification settings", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerCommentRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Internal comment added successfully" }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Versions/{customerId}": { "get": { "tags": [ "Customers | B2C | Versions" ], "summary": "Get a list of all version items.", "operationId": "PrivateCustomerVersionsVersionList", "parameters": [ { "name": "customerId", "in": "path", "description": "Customer ID to fetch the version list for", "required": true, "schema": { "type": "string", "description": "Customer ID to fetch the version list for", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PrivateCustomers/Versions/{customerId}/{versionId}": { "get": { "tags": [ "Customers | B2C | Versions" ], "summary": "Get specific private customer version", "operationId": "PrivateCustomerGetVersion", "parameters": [ { "name": "customerId", "in": "path", "description": "Customer ID", "required": true, "schema": { "type": "string", "description": "Customer ID", "nullable": true } }, { "name": "versionId", "in": "path", "description": "Version ID to fetch", "required": true, "schema": { "type": "string", "description": "Version ID to fetch", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPrivateCustomerOmniumVersion" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductAlerts/Add": { "post": { "tags": [ "Products | Alerts" ], "summary": "Add or Update a productAlert. If ID is null, it will be created.", "operationId": "ProductAlertsAdd", "requestBody": { "description": "The product alert object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductAlerts/Deactivate": { "delete": { "tags": [ "Products | Alerts" ], "summary": "Deactivate productAlerts. Active flag will be set to false, and contact information will be removed.", "operationId": "ProductAlertsDeactivate", "parameters": [ { "name": "omniumProductAlertIds", "in": "query", "description": "Product alert Ids - The id of product alert objects to deactivate", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Product alert Ids - The id of product alert objects to deactivate" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductAlerts/GetProductAlerts": { "get": { "tags": [ "Products | Alerts" ], "summary": "Get ProductAlerts.", "operationId": "ProductAlertsGetProductAlerts", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer", "description": "Page number", "format": "int32", "default": 1 } }, { "name": "take", "in": "query", "description": "Number of elements", "schema": { "type": "integer", "description": "Number of elements", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductAlerts/SearchProductAlerts": { "post": { "tags": [ "Products | Alerts" ], "summary": "Search for product alerts.", "operationId": "ProductAlertsSearchProductAlerts", "requestBody": { "description": "Request with search params", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductAlertSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/{categoryId}": { "get": { "tags": [ "Products | Categories" ], "summary": "Get product category. Language code has to be specified, either in the id or in the language parameter. If not default value will be used.", "operationId": "ProductCategoriesGetCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "ID or categoryId, i.e. the id with or without language code (\"123\" or \"123_no\").", "required": true, "schema": { "type": "string", "description": "ID or categoryId, i.e. the id with or without language code (\"123\" or \"123_no\").", "nullable": true } }, { "name": "language", "in": "query", "description": "Language code. If language code is not given in the id (\"123\"), then language code should be set (\"no\"). If language code is neither given in the id nor here, the category in default product language will be returned.", "schema": { "type": "string", "description": "Language code. If language code is not given in the id (\"123\"), then language code should be set (\"no\"). If language code is neither given in the id nor here, the category in default product language will be returned.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Category found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } } } }, "400": { "description": "Category ID is not valid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Category not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Products | Categories" ], "summary": "Patch a product category - update only values in request", "operationId": "ProductCategoriesPatchCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "Category ID to patch (id including language, e.g. \"123_no\")", "required": true, "schema": { "type": "string", "description": "Category ID to patch (id including language, e.g. \"123_no\")", "nullable": true } } ], "requestBody": { "description": "Patch request containing fields to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product category updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } } } }, "400": { "description": "Patch request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product category not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories": { "get": { "tags": [ "Products | Categories" ], "summary": "Get product categories. Returns all categories in all languages.", "operationId": "ProductCategoriesGetCategories", "parameters": [ { "name": "pageSize", "in": "query", "description": "Number of items. Max page size is 1000", "schema": { "type": "integer", "description": "Number of items. Max page size is 1000", "format": "int32", "default": 1000 } }, { "name": "page", "in": "query", "description": "Page", "schema": { "type": "integer", "description": "Page", "format": "int32", "default": 1 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Categories found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } } } }, "400": { "description": "Search error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "Products | Categories" ], "summary": "Add a new product category to the OMS", "operationId": "ProductCategoriesPost", "requestBody": { "description": "Product category to be added to the OMS. CategoryId is required. If language is not given, default product language will be set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Product category created" }, "400": { "description": "Product category is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Products | Categories" ], "summary": "Put a product category to the OMS, CAUTION: overwriting existing product category", "operationId": "ProductCategoriesPut", "requestBody": { "description": "Product category to be put to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategory" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product category updated" }, "400": { "description": "Product category is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/GetCategoryTree": { "get": { "tags": [ "Products | Categories" ], "summary": "Get product category tree", "operationId": "ProductCategoriesGetCategoryTree", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product category tree found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Search error" } } } }, "/api/ProductCategories/GetCategoryTreeBySearch": { "post": { "tags": [ "Products | Categories" ], "summary": "Get product category tree by product search", "operationId": "ProductCategoriesGetCategoryTreeBySearch", "parameters": [ { "name": "rootCategoryId", "in": "query", "schema": { "type": "string", "nullable": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product category tree found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Search error" } } } }, "/api/ProductCategories/{parentId}/SubCategories": { "get": { "tags": [ "Products | Categories" ], "summary": "Retrieves all immediate subcategories for a given parent category from the category index.", "operationId": "ProductCategoriesGetSubCategories", "parameters": [ { "name": "parentId", "in": "path", "description": "The ID of the parent category. For example, use the root category ID to fetch top-level categories.\r\nIf the root category is not defined, you can pass \"rootCategoryId\" to retrieve the top-level categories.", "required": true, "schema": { "type": "string", "description": "The ID of the parent category. For example, use the root category ID to fetch top-level categories.\r\nIf the root category is not defined, you can pass \"rootCategoryId\" to retrieve the top-level categories.", "nullable": true } }, { "name": "language", "in": "query", "description": "Language code, e.g. no, en", "schema": { "type": "string", "description": "Language code, e.g. no, en", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Sub categories found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" } } } } }, "400": { "description": "Parent ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/AddMany": { "post": { "tags": [ "Products | Categories" ], "summary": "Add many product categories to the OMS", "operationId": "ProductCategoriesAddMany", "requestBody": { "description": "Product categories to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Product categories created" }, "400": { "description": "Product categories are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/{productCategoryId}": { "delete": { "tags": [ "Products | Categories" ], "summary": "Deletes a product category from the OMS", "operationId": "ProductCategoriesDelete", "parameters": [ { "name": "productCategoryId", "in": "path", "description": "ID of the category to delete (id including language)", "required": true, "schema": { "type": "string", "description": "ID of the category to delete (id including language)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product category deleted" }, "400": { "description": "Product category ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product category does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/PatchMany": { "patch": { "tags": [ "Products | Categories" ], "summary": "Patch many product categories - update only values in request", "operationId": "ProductCategoriesPatchMany", "requestBody": { "description": "List of patch requests. Id or CategoryId with Language is required to identify each category.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" }, "description": "List of patch requests. Id or CategoryId with Language is required to identify each category.", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" }, "description": "List of patch requests. Id or CategoryId with Language is required to identify each category.", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" }, "description": "List of patch requests. Id or CategoryId with Language is required to identify each category.", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryPatch" }, "description": "List of patch requests. Id or CategoryId with Language is required to identify each category.", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product categories updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryUpdateResult" } } } }, "400": { "description": "Patch request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProductCategories/ScrollSearch": { "post": { "tags": [ "Products | Categories" ], "summary": "Scroll search categories. The response will contain a Scroll ID which can be used with the Scroll endpoint to fetch all remaining items.\r\nWe accept max take size 10 000. Fallback to 5000 if greater than max, or not set", "operationId": "ProductCategoriesScrollSearch", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategorySearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategorySearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategorySearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategorySearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Categories found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumSearchResult" } } } }, "400": { "description": "Search error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ProductCategories/Scroll/{id}": { "get": { "tags": [ "Products | Categories" ], "summary": "Scroll product categories is used to get a large amount of categories.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "ProductCategoriesScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductCategoryOmniumResult" } } } } } } }, "/api/products/Query": { "post": { "tags": [ "Products | Query (Preview)" ], "summary": "🧪 [Preview] Query products. Returns full product models with explicit control over market, store, and customer context.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nPrimary endpoint for fetching products: single-product lookups, filtered lists, and\r\npaginated UI queries. Pagination is capped at offset (Take * Page) of 10,000 — past that,\r\nuse POST /api/products/Query/Scroll.\r\n \r\nAll filter fields are documented on the request schema below.\r\n \r\nFor the full reference, the ID-lookup matrix, and response-size guidance, see\r\nhttps://docs.omnium.no/docs/Integrations/product-query.\r\n \r\n### Examples\r\n \r\n**1. Single product with market pricing.** The simplest case — one product, prices filtered\r\nto one market.\r\n```json\r\n{\r\n \"productIds\": [\"PROD-123\"],\r\n \"marketIds\": [\"NOR\"]\r\n}\r\n```\r\n \r\n**2. Single product with market pricing and tight payload** (recommended). Same as above\r\nbut only the fields you actually need. Variants come back with just `skuId` and `size` —\r\nevery other variant field is stripped. Cart pickers, barcode reverse-lookups, detail views.\r\n```json\r\n{\r\n \"productIds\": [\"PROD-123\"],\r\n \"marketIds\": [\"NOR\"],\r\n \"fields\": { \"include\": [\"productId\", \"name\", \"prices\", \"variants.skuId\", \"variants.size\"] }\r\n}\r\n```\r\n \r\n**3. Category list page.** Paginated browse with market context and a tight response —\r\nthe canonical product-list-in-a-UI pattern.\r\n```json\r\n{\r\n \"take\": 50,\r\n \"page\": 1,\r\n \"marketIds\": [\"NOR\"],\r\n \"productCategoryIds\": [\"CAT-summer-clothing\"],\r\n \"isActive\": true,\r\n \"fields\": { \"include\": [\"productId\", \"name\", \"prices\", \"mainImageUrl\", \"variants.skuId\"] }\r\n}\r\n```\r\n \r\n**4. Raw product lookup — all prices, no context filtering.** Use `includeAllPrices: true`\r\nto bypass price-context filtering while keeping product-availability filtering. Useful for\r\nprice management UIs and audits where you need every price for a product, not just the\r\nmarket/store/customer-relevant ones.\r\n```json\r\n{\r\n \"productIds\": [\"PROD-123\"],\r\n \"marketIds\": [\"NOR\"],\r\n \"includeAllPrices\": true\r\n}\r\n```\r\n \r\n**5. Price context — scope prices independently of availability.** Top-level fields filter which\r\nproducts are returned; `priceContext` controls which prices come back (and how they sort). Each\r\n`priceContext` field overrides its top-level counterpart for pricing only — anything left out\r\nfalls back to the top-level value, so the common case needs no `priceContext` at all. Store\r\ngroups and additional price stores live here only (they never filter products). Below: products\r\navailable in `SWE`, priced for the `SWE` market *and* the `MiraklSellers` store group, club\r\nprices included.\r\n```json\r\n{\r\n \"marketIds\": [\"SWE\"],\r\n \"productParentIds\": [\"354931\"],\r\n \"isCustomerClubMember\": true,\r\n \"priceContext\": { \"storeGroupIds\": [\"MiraklSellers\"] }\r\n}\r\n```", "operationId": "ProductQueryQuery", "requestBody": { "description": "Query request with filters, market/store context, pagination, and field selection", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductQueryRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Query successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumQueryResult" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "x-preview": true } }, "/api/products/Query/Scroll": { "post": { "tags": [ "Products | Query (Preview)" ], "summary": "🧪 [Preview] Initiate a scroll session for retrieving large product datasets.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nBulk extraction endpoint — full-catalog syncs (PIM, ERP, marketplace), exports,\r\nsearch-index reindexing. Also required past the 10,000 offset cap on POST /Query.\r\n \r\nReturns a `scrollId` and the first batch. Pass `scrollId` to\r\nGET /api/products/Query/Scroll/{scrollId} until it comes back null. Sessions expire after\r\n10 minutes of inactivity; per-tenant concurrency is capped.\r\n \r\nSame filter set as POST /Query (see request schema) and identical response shape — price\r\ncontext filtering, inventory cleanup and property-list shaping apply on both the initial\r\nbatch and continuations.\r\n \r\nFor full bulk-sync recipes (delta queries, idempotent pipelines) and response-size\r\nguidance, see https://docs.omnium.no/docs/Integrations/product-query.\r\n \r\n### Canonical example\r\nDelta sync — capture every product touched in a 5-minute window (modifications, publish/\r\nunpublish events, price activations/deactivations) in a single pass. Run on a cron for an\r\nidempotent replication pipeline:\r\n```json\r\n{\r\n \"marketIds\": [\"NOR\"],\r\n \"scrollSize\": 500,\r\n \"isUnionDeltaQuery\": true,\r\n \"modifiedFrom\": \"2025-01-08T10:15:00Z\",\r\n \"startPublishFrom\": \"2025-01-08T10:15:00Z\",\r\n \"startPublishTo\": \"2025-01-08T10:20:00Z\",\r\n \"stopPublishFrom\": \"2025-01-08T10:15:00Z\",\r\n \"stopPublishTo\": \"2025-01-08T10:20:00Z\",\r\n \"priceActivatedFrom\": \"2025-01-08T10:15:00Z\",\r\n \"priceActivatedTo\": \"2025-01-08T10:20:00Z\",\r\n \"priceDeactivatedFrom\": \"2025-01-08T10:15:00Z\",\r\n \"priceDeactivatedTo\": \"2025-01-08T10:20:00Z\"\r\n}\r\n```", "operationId": "ProductQueryQueryScroll", "requestBody": { "description": "Query request with filters, market/store context, and field selection", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductScrollQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductScrollQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductScrollQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductScrollQueryRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Scroll initiated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "x-preview": true } }, "/api/products/Query/Scroll/{scrollId}": { "get": { "tags": [ "Products | Query (Preview)" ], "summary": "🧪 [Preview] Continue an active scroll session and fetch the next batch of products.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nCall repeatedly with the latest returned `scrollId` until it comes back null. Sessions\r\nexpire after 10 minutes of inactivity. See `POST /api/products/Query/Scroll` for the\r\ninitiation endpoint and full request shape.", "operationId": "ProductQueryScrollContinuation", "parameters": [ { "name": "scrollId", "in": "path", "description": "The scroll ID from the previous response (initial Scroll call or a prior continuation)", "required": true, "schema": { "type": "string", "description": "The scroll ID from the previous response (initial Scroll call or a prior continuation)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Scroll continuation successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumScrollableQueryResult" } } } } }, "x-preview": true } }, "/api/Products/GetNextProductNumber": { "get": { "tags": [ "Products" ], "summary": "Get next generated product number.", "description": "Requires that ProductNumberOptions is configured, with auto create enabled.", "operationId": "ProductsGetNextProductNumber", "parameters": [ { "name": "marketId", "in": "query", "description": "Optional: Provide if multiple ProductNumberOptions configured", "schema": { "type": "string", "description": "Optional: Provide if multiple ProductNumberOptions configured", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "ProductNumber" }, "400": { "description": "ProductNumber not available", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "NumberOptions not configured", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/PatchMany": { "patch": { "tags": [ "Products | Batch Updates" ], "summary": "Patch product - update only values in request", "description": "Patch of \"Properties\" is flexible and can be customized in several ways:\r\n
\r\n- The \"Patch.Properties\" property contains the properties to be updated.\r\n
\r\n- The \"Patch.PropertiesRemovalConditions\" property specifies conditions for removing existing properties before applying updates.\r\n
\r\n- The \"Patch.KeepExistingCustomProperties\" property controls whether new properties are added to existing ones (default: \"true\") or if the entire list should be replaced (default: \"false\").\r\n
\r\n- The \"Patch.DontOverwriteExistingPropertyValues\" property prevents updating properties that already have values.\r\n
\r\nThis is especially useful for list or multi-select properties. Set this to \"true\" along with 'ValueType: \"List\" or \"DropDown\"' in \"Properties\" to add to lists without replacing them.\r\n

\r\nSee property summary under schema for more information.\r\n
", "operationId": "ProductsPatchMany", "parameters": [ { "name": "excludeProductExport", "in": "query", "description": "If this is set to true, Omnium will not export products to external systems", "schema": { "type": "boolean", "description": "If this is set to true, Omnium will not export products to external systems", "default": false } } ], "requestBody": { "description": "Patch requests. Id is required. If not set, the patch request will be skipped.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests. Id is required. If not set, the patch request will be skipped.", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests. Id is required. If not set, the patch request will be skipped.", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests. Id is required. If not set, the patch request will be skipped.", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests. Id is required. If not set, the patch request will be skipped.", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductsAndVariantsUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductsAndVariantsUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductsAndVariantsUpdateResult" } } } }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/Variants/Search": { "post": { "tags": [ "Obsolete" ], "summary": "Search for variants | Obsolete: Use product search instead.", "operationId": "ProductsSearchVariants", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning variants", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } } } }, "400": { "description": "Search request invalid" } }, "deprecated": true } }, "/api/Products/Variants/ReindexVariantIndexByProductIds": { "post": { "tags": [ "Obsolete" ], "summary": "Reindex variant index by product id", "operationId": "ProductsReindexVariantIndexByProductIds", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Reindex successful" }, "400": { "description": "Invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Products do not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } }, "deprecated": true } }, "/api/Products/Orders/ProductStatistics": { "post": { "tags": [ "Products" ], "summary": "Create product statistics", "operationId": "ProductsCreateProductStatistics", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductStatisticsSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductStatisticsSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductStatisticsSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductStatisticsSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product statistics returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductSales" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSales" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSales" } } } }, "204": { "description": "Success" }, "400": { "description": "Search request is not valid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/{productId}": { "get": { "tags": [ "Products | Get" ], "summary": "Get product by Product ID or SKU ID. Product will be returned with all valid prices(for all markets/stores) sorted by defaultMarket, excluding customer specific prices.\r\nFor the complete product, with all prices and no sorting, use GET \"products/{id}/raw\")", "operationId": "ProductsGet", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID or SKU ID", "required": true, "schema": { "type": "string", "description": "Product ID or SKU ID" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "404": { "description": "Product or SKU does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Products | Update" ], "summary": "Deletes a product from the OMS", "operationId": "ProductsDelete", "parameters": [ { "name": "productId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Product deleted successfully" }, "404": { "description": "Product was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Products | Update" ], "summary": "Patch product - update only values in request", "operationId": "ProductsPatchProduct", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to patch", "required": true, "schema": { "type": "string", "description": "Product ID to patch", "nullable": true } } ], "requestBody": { "description": "Patch request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } } } }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/{id}/raw": { "get": { "tags": [ "Products | Get" ], "summary": "Get product by product ID. Returned as is, with no exclusion or sorting of prices.", "operationId": "ProductsGetRawProduct", "parameters": [ { "name": "id", "in": "path", "description": "Product document ID (including language post-fix when using product languages)", "required": true, "schema": { "type": "string", "description": "Product document ID (including language post-fix when using product languages)" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/{productId}/ByMarket/{marketId}": { "get": { "tags": [ "Products | Get" ], "summary": "Get product by Product ID or SKU ID. Product will be returned with prices ONLY for selected market. If you need the complete object, use get without market", "operationId": "ProductsGetProductByMarket", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID or SKU ID", "required": true, "schema": { "type": "string", "description": "Product ID or SKU ID" } }, { "name": "marketId", "in": "path", "description": "Market ID for product and prices", "required": true, "schema": { "type": "string", "description": "Market ID for product and prices" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "400": { "description": "Invalid marketId", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product or SKU does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/{productId}/ByStore/{storeId}": { "get": { "tags": [ "Products | Get" ], "summary": "Get product by Product ID or SKU ID. Product will be returned with prices ONLY for selected store, or valid market for store. If you need the complete object, use get without store or market", "operationId": "ProductsGetProductByStore", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID or SKU ID", "required": true, "schema": { "type": "string", "description": "Product ID or SKU ID" } }, { "name": "storeId", "in": "path", "description": "Store ID for product and prices", "required": true, "schema": { "type": "string", "description": "Store ID for product and prices" } }, { "name": "isAssortmentIgnored", "in": "query", "description": "True if assortment should be ignored", "schema": { "type": "boolean", "description": "True if assortment should be ignored" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "400": { "description": "Product ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product or SKU does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/{productId}/ByCustomer": { "get": { "tags": [ "Products | Get" ], "summary": "Get product by Product ID or SKU ID. Product will be returned with relevant prices for the selected customer or customer group. If both the product and customer has assortment codes set, the product will not be returned if there is a mismatch and status 404 will be returned instead.", "operationId": "ProductsGetProductByCustomer", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID or SKU ID", "required": true, "schema": { "type": "string", "description": "Product ID or SKU ID", "nullable": true } }, { "name": "customerId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "customerGroup", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "404": { "description": "Product or SKU does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products": { "post": { "tags": [ "Products | Update" ], "summary": "Create new product, update if exists", "description": "Sample request for adding a product with three variants, market prices and customer specific price, assets and a custom property.\r\n \r\n POST /api/products\r\n {\r\n \"id\": \"ABC-123_no\",\r\n \"productId\": \"ABC-123\",\r\n \"parentId\": \"ABC\",\r\n \"language\": \"no\",\r\n \"name\": \"Omnium Super Stylish sweater /w logo\",\r\n \"color\": \"black\",\r\n \"shortDescription\": \"A black cotton sweater\",\r\n \"description\": \"A beautifully made sweater, with a stylish black color and the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.\",\r\n \"brand\": \"Omnium Sweaters 'n Jeans\",\r\n \"season\": \"FW22\",\r\n \"unit\": \"pcs\",\r\n \"weight\": 900,\r\n \"created\": \"2022-11-11T00:00:00\",\r\n \"published\": \"2022-12-12T00:00:00\",\r\n \"isActive\": true,\r\n \"variants\": [\r\n {\r\n \"skuId\": \"000000000001\",\r\n \"isActive\": true,\r\n \"isSku\": true,\r\n \"size\": \"S\"\r\n },\r\n {\r\n \"skuId\": \"000000000002\",\r\n \"isActive\": true,\r\n \"isSku\": true,\r\n \"size\": \"M\"\r\n },\r\n {\r\n \"skuId\": \"000000000003\",\r\n \"isActive\": true,\r\n \"isSku\": true,\r\n \"size\": \"L\"\r\n }\r\n ],\r\n \"prices\": [\r\n {\r\n \"marketId\": \"NOR\",\r\n \"unitPrice\": 500,\r\n \"currencyCode\": \"NOK\"\r\n },\r\n {\r\n \"marketId\": \"NOR\",\r\n \"code\": \"000000000002\",\r\n \"validFrom\": \"2022-01-01T00:00:00\",\r\n \"validUntil\": \"2023-01-01T00:00:00\",\r\n \"unitPrice\": 250,\r\n \"currencyCode\": \"NOK\",\r\n \"customerGroup\": \"100\",\r\n \"discountAmount\": 250,\r\n \"discountPercent\": 50,\r\n \"originalUnitPrice\": 500\r\n }\r\n ],\r\n \"assets\": [\r\n {\r\n \"assetId\": \"78901\",\r\n \"sortOrder\": 1,\r\n \"url\": \"https://omnium-cdn-url-goes-here.com/id/305/200/300\",\r\n \"externalUrl\": \"https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw\",\r\n \"isMainImage\": true\r\n },\r\n {\r\n \"assetId\": \"12345\",\r\n \"sortOrder\": 2,\r\n \"url\": \"https://omnium-cdn-url-goes-here.com/id/544/200/300\",\r\n \"externalUrl\": \"https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0\",\r\n \"name\": \"Close-up Omnium Awesome Sweater\",\r\n \"description\": \"Close-up on the sweater, but this is just a random image though.\",\r\n \"altText\": \"Close-up\"\r\n }\r\n ],\r\n \"properties\": [\r\n {\r\n \"key\": \"CollarType\",\r\n \"value\": \"CrewNeck\"\r\n },\r\n {\r\n \"key\": \"IsAwesome\",\r\n \"value\": \"true\",\r\n \"valueType\": \"Boolean\"\r\n }\r\n ]\r\n }", "operationId": "ProductsPost", "requestBody": { "description": "Product to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Product created successfully" }, "400": { "description": "Product is invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Products | Update" ], "summary": "Put a product to Omnium, CAUTION: overwriting existing product", "operationId": "ProductsPutProduct", "requestBody": { "description": "Product to put", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Product put successfully" }, "400": { "description": "Product is invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/AddMany": { "post": { "tags": [ "Products | Batch Updates" ], "summary": "Add multiple products to Omnium", "operationId": "ProductsAddMany", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Products added successfully" }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/DeleteMany": { "delete": { "tags": [ "Products | Batch Updates" ], "summary": "Delete multiple products from Omnium", "operationId": "ProductsDeleteMany", "requestBody": { "description": "The Ids of the products to delete (OmniumProduct.Id, e.g 12345_en)", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "The Ids of the products to delete (OmniumProduct.Id, e.g 12345_en)" } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "The Ids of the products to delete (OmniumProduct.Id, e.g 12345_en)" } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "The Ids of the products to delete (OmniumProduct.Id, e.g 12345_en)" } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "The Ids of the products to delete (OmniumProduct.Id, e.g 12345_en)" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Delete request not valid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Products deleted successfully" } } } }, "/api/Products/UpdateMany": { "post": { "tags": [ "Products | Batch Updates" ], "summary": "Update (add) many products, enriching existing products if they exist\r\nExternalIds will be added or updated.\r\nPropertyItems will be overwritten.", "operationId": "ProductsUpdateMany", "parameters": [ { "name": "excludeProductExport", "in": "query", "description": "True if products not should be exported to external systems (by integration, queues, webhooks, etc)", "schema": { "type": "boolean", "description": "True if products not should be exported to external systems (by integration, queues, webhooks, etc)", "default": false } } ], "requestBody": { "description": "List of products to be updated", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "List of products to be updated", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "List of products to be updated", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "List of products to be updated", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "List of products to be updated", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Products added successfully" } } } }, "/api/Products/SearchProducts": { "post": { "tags": [ "Products | Search" ], "summary": "Search for products, return product list items. Does not return entire product models.", "operationId": "ProductsSearchProducts", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning product list items (view model)", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/{productId}/Variants": { "get": { "tags": [ "Products | Get" ], "summary": "Get list of variants by product ID", "operationId": "ProductsGetVariants", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID or SKU id", "required": true, "schema": { "type": "string", "description": "Product ID or SKU id", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product and variants found, returning list of variants", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumSearchResult" } } } }, "404": { "description": "Product does not exist, or does not contain variants", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Products | Variants" ], "summary": "Patch many product variants - update only values in request", "operationId": "ProductsPatchManyVariants", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to patch", "required": true, "schema": { "type": "string", "description": "Product ID to patch", "nullable": true } } ], "requestBody": { "description": "Patch requests", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPatch" }, "description": "Patch requests", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } } } }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "Products | Variants" ], "summary": "Add a new variant to Omnium", "operationId": "ProductsPostVariant", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to add variant to", "required": true, "schema": { "type": "string", "description": "Product ID to add variant to", "nullable": true } } ], "requestBody": { "description": "Variant to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariant" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariant" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariant" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Variant created successfully" }, "400": { "description": "Variant is invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Products | Variants" ], "summary": "Put a variant to Omnium, CAUTION: overwriting existing variant", "operationId": "ProductsPutVariant", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to add variant to", "required": true, "schema": { "type": "string", "description": "Product ID to add variant to", "nullable": true } } ], "requestBody": { "description": "Variant to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Variant put successfully" }, "404": { "description": "Product not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Variant is invalid" } } } }, "/api/Products/ProductCategories/{productCategoryId}": { "get": { "tags": [ "Products | Get" ], "summary": "Get list of products by product category id", "operationId": "ProductsGetByCategory", "parameters": [ { "name": "productCategoryId", "in": "path", "description": "Product Category ID", "required": true, "schema": { "type": "string", "description": "Product Category ID", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.(default is 20)", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Max 100. Minimum 1.(default is 20)", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found, returning search result", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Products not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/ProductSearch/{productSearchId}": { "get": { "tags": [ "Products | Get" ], "summary": "Get list of products by product search id", "operationId": "ProductsGetByProductSearch", "parameters": [ { "name": "productSearchId", "in": "path", "description": "Product Search ID", "required": true, "schema": { "type": "string", "description": "Product Search ID", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1(default is 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "Current page of the search request. Minimum 1(default is 1)", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.(default is 20)", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Max 100. Minimum 1.(default is 20)", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product found, returning search result", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductListItemViewModelOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Products not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/ProductCategories": { "put": { "tags": [ "Products | Categories" ], "summary": "Add product categories to products by IDs", "operationId": "ProductsAddCategoriesToProducts", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryRelationsRequest" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryRelationsRequest" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryRelationsRequest" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryRelationsRequest" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } } } }, "400": { "description": "Request is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error" }, "204": { "description": "Product categories added successfully" } } } }, "/api/Products/{productId}/Variants/{variantId}": { "patch": { "tags": [ "Products | Variants" ], "summary": "Patch product - update only values in request", "operationId": "ProductsPatchVariant", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to patch", "required": true, "schema": { "type": "string", "description": "Product ID to patch", "nullable": true } }, { "name": "variantId", "in": "path", "description": "Sku ID to patch", "required": true, "schema": { "type": "string", "description": "Sku ID to patch", "nullable": true } } ], "requestBody": { "description": "Patch request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } } } }, "400": { "description": "Products are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "get": { "tags": [ "Products | Variants" ], "summary": "Get a variant by product and variant ID", "operationId": "ProductsGetVariant", "parameters": [ { "name": "productId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "variantId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Variants found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "404": { "description": "Product or variant not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Products | Variants" ], "summary": "Deletes a variant from a product", "operationId": "ProductsDeleteVariant", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID", "required": true, "schema": { "type": "string", "description": "Product ID", "nullable": true } }, { "name": "variantId", "in": "path", "description": "Variant ID", "required": true, "schema": { "type": "string", "description": "Variant ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Variant deleted successfully" }, "404": { "description": "Product or variant does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error" } } } }, "/api/Products/Variants/{variantId}": { "get": { "tags": [ "Products | Variants" ], "summary": "Get a variant by variant ID", "operationId": "ProductsGetVariantByVariantId", "parameters": [ { "name": "variantId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Variants found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductVariantOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariantOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductVariantOmniumSearchResult" } } } }, "404": { "description": "Variant not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Products/{productId}/VariantList": { "post": { "tags": [ "Products | Variants" ], "summary": "Add new variants to Omnium", "operationId": "ProductsPostManyVariants", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to add variant to", "required": true, "schema": { "type": "string", "description": "Product ID to add variant to", "nullable": true } } ], "requestBody": { "description": "Variant to add", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "Variant to add", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "Variant to add", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "Variant to add", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "Variant to add", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Variant created successfully" }, "400": { "description": "Variant is invalid", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/AddProductImage": { "get": { "tags": [ "Products | Assets" ], "summary": "Add image to product", "operationId": "ProductsAddProductImage", "parameters": [ { "name": "url", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "productId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Image added successfully" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Product ID or url missing" } } } }, "/api/Products/Assets/AddAsset/{productId}": { "post": { "tags": [ "Products | Assets" ], "summary": "Add asset to product from a binary stream. The request body should be the raw file content.", "description": "Add new product asset from stream", "operationId": "ProductsAddAsset", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID", "required": true, "schema": { "type": "string", "description": "Product ID", "nullable": true } }, { "name": "fileName", "in": "query", "description": "File name including extension (e.g. \"image.png\")", "schema": { "type": "string", "description": "File name including extension (e.g. \"image.png\")", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } } } }, "400": { "description": "Unknown file type or upload failed", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/Assets/GetAssets": { "get": { "tags": [ "Products | Assets" ], "summary": "Get product assets", "operationId": "ProductsGetAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning assets", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } } } }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Products/Assets/AddAssets/{skuId}": { "post": { "tags": [ "Products | Assets" ], "summary": "Add assets to product. Will overwrite existing assets if there are assets added with the same asset ID on the product.", "operationId": "ProductsAddAssets", "parameters": [ { "name": "skuId", "in": "path", "description": "Product ID or SKU for the product, or a matching SKU for one on the product variants", "required": true, "schema": { "type": "string", "description": "Product ID or SKU for the product, or a matching SKU for one on the product variants", "nullable": true } }, { "name": "isAddedToVariant", "in": "query", "description": "If set to true, the asset will be added to the variant with a matching", "schema": { "type": "boolean", "description": "If set to true, the asset will be added to the variant with a matching" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully" }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Products/Assets/UpdateAssets": { "post": { "tags": [ "Products | Assets" ], "summary": "Update asset to product", "operationId": "ProductsUpdateAssets", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset updated successfully" }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Products/Assets/DeleteAssets": { "delete": { "tags": [ "Products | Assets" ], "summary": "Delete assets from products", "operationId": "ProductsDeleteAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset deleted successfully" }, "404": { "description": "Product does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Product ID or url missing" } } } }, "/api/Products/GetActivePromotions": { "post": { "tags": [ "Promotions" ], "summary": "Search for active promotion IDs", "operationId": "ProductsGetActivePromotions", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning list of promotion ids", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductPromotionIdSearchResultOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPromotionIdSearchResultOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductPromotionIdSearchResultOmniumSearchResult" } } } }, "400": { "description": "Search request invalid" } } } }, "/api/Products/{productId}/Options": { "get": { "tags": [ "Products" ], "summary": "Get product options for product", "operationId": "ProductsGetProductOptions", "parameters": [ { "name": "productId", "in": "path", "description": "Product ID for the product which has product options", "required": true, "schema": { "type": "string", "description": "Product ID for the product which has product options", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product options returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOptionsViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOptionsViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOptionsViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Product not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Products/Scroll/{id}": { "get": { "tags": [ "Products | Search" ], "summary": "Scroll products is used to get a large amount of products.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "ProductsScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } } } } } } }, "/api/Products/Scroll": { "post": { "tags": [ "Products | Search" ], "summary": "Scroll through products based on search criteria.", "description": "Scrolling is intended for processing large datasets and is not suitable for real-time user interactions.\r\nUse scroll endpoints when you need to retrieve all items resulting from the search, as pagination (i.e., 'take' and 'page' parameters) is disabled for scroll searches.\r\n \r\nIf the `scrollId` property is return from the search, continue fetching the remaining products using the `/api/products/scroll/{id}` endpoint until there are no more products to scroll. If it is not returned, it means that all products were returned in the initial result", "operationId": "ProductsScrollSearch", "requestBody": { "description": "The request object containing search parameters for products.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search was successful. Products are returned and possibly a scroll ID", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductOmniumResult" } } } }, "400": { "description": "The search request is invalid, likely due to incorrect parameters." } } } }, "/api/settings/ProductSettings/ProductSettings": { "get": { "tags": [ "Settings | Products" ], "summary": "Returns all product settings.", "operationId": "ProductSettingsProductSettings", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProductSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductSettings" } } } } } } }, "/api/settings/ProductSettings/ProductType": { "put": { "tags": [ "Settings | Products" ], "summary": "Add a product type, or update if a product type with the same name already exists.", "operationId": "ProductSettingsProductType", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProductTypeItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProductTypeItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProductTypeItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProductTypeItem" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/settings/ProductSettings/DeleteProductType/{name}": { "delete": { "tags": [ "Settings | Products" ], "summary": "Delete the product type with the given name.", "operationId": "ProductSettingsDeleteProductType", "parameters": [ { "name": "name", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found" }, "200": { "description": "Success" } } } }, "/api/Projects/{projectId}/Log": { "get": { "tags": [ "Projects | Logs" ], "summary": "Get log items for a project (sorted by date descending)", "operationId": "ProjectLogsGetProjectLog", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/ProjectLogs/Search": { "post": { "tags": [ "Projects | Logs" ], "summary": "Search project logs", "description": "Search project logs.", "operationId": "ProjectLogsSearch", "requestBody": { "description": "Search request object for project logs", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLogSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/ProjectLogs/Add": { "put": { "tags": [ "Projects | Logs" ], "summary": "Add/update project log item", "description": "Add/update a project log item.", "operationId": "ProjectLogsAdd", "requestBody": { "description": "Omnium ProjectLog object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/ProjectLogs/{id}": { "delete": { "tags": [ "Projects | Logs" ], "summary": "Delete project log item", "operationId": "ProjectLogsDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project log item deleted" }, "404": { "description": "Project not found" }, "400": { "description": "Invalid request" } } } }, "/api/ProjectReports/GetProjectDailyReports": { "post": { "tags": [ "Projects | Reports" ], "summary": "Search, filter and generate project daily stats", "operationId": "ProjectReportsGetProjectDailyReports", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectDailyReport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectDailyReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectDailyReport" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProjectReports/GetProjectTypeReports": { "post": { "tags": [ "Projects | Reports" ], "summary": "Get project type stats for a given time-span.\r\nStats exclude deleted projects and projects without ProjectTypeName. \r\nStats only return stats on stores to which the user has access.\r\nStats include all project created before toDate that are still ongoing or was cancelled or finished within the time-span.", "operationId": "ProjectReportsGetProjectTypeReports", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypeReportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypeReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypeReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypeReportRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTypeReport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTypeReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTypeReport" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Get single project", "operationId": "ProjectsGet", "parameters": [ { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Project ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/GetProjectsByPartner": { "get": { "tags": [ "Projects" ], "summary": "Get all projects associated with supplier", "operationId": "ProjectsGetProjectsByPartner", "parameters": [ { "name": "partnerId", "in": "query", "description": "Partner identification", "schema": { "type": "string", "description": "Partner identification", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32" } }, { "name": "sortOrder", "in": "query", "description": "Property to sort by", "schema": { "type": "string", "description": "Property to sort by", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Projects found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "No projects found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/GetProjectsByCustomer": { "get": { "tags": [ "Projects" ], "summary": "Get all projects associated with customer", "operationId": "ProjectsGetProjectsByCustomer", "parameters": [ { "name": "customerId", "in": "query", "description": "Customer identification", "schema": { "type": "string", "description": "Customer identification", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32" } }, { "name": "sortOrder", "in": "query", "description": "Property to sort by", "schema": { "type": "string", "description": "Property to sort by", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Projects found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "No projects found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Search": { "post": { "tags": [ "Projects" ], "summary": "Search for projects", "operationId": "ProjectsSearch", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Create": { "get": { "tags": [ "Projects" ], "summary": "Add project to OMS.", "operationId": "ProjectsCreate", "parameters": [ { "name": "projectTypeId", "in": "query", "description": "ID of the project type to create", "schema": { "type": "string", "description": "ID of the project type to create", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Projects created and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "ProjectTypeId invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/AddLogItem": { "post": { "tags": [ "Projects" ], "summary": "Add log item to project", "operationId": "ProjectsAddLogItem", "parameters": [ { "name": "projectId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectLog" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Activate": { "post": { "tags": [ "Projects" ], "summary": "Activate project - Used to reactivate cancelled projects or projects on hold. Will trigger reactivation notification if configured on the project type.", "operationId": "ProjectsActivate", "parameters": [ { "name": "projectId", "in": "query", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "comment", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/UpdateProjectStatus": { "post": { "tags": [ "Projects" ], "operationId": "ProjectsUpdateProjectStatus", "parameters": [ { "name": "projectId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "status", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "comment", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/UpdateProjectProductStatus": { "post": { "tags": [ "Projects" ], "summary": "Update the status of individual products in a project", "operationId": "ProjectsUpdateProjectProductStatus", "requestBody": { "description": "Request containing project ID and per-product status updates", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateProjectProductStatusRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateProjectProductStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateProjectProductStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateProjectProductStatusRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Product statuses updated successfully. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects": { "put": { "tags": [ "Projects" ], "summary": "Update project", "operationId": "ProjectsUpdateProject", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, workflow will be processed", "schema": { "type": "boolean", "description": "If true, workflow will be processed", "default": false } } ], "requestBody": { "description": "Project to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectUpdateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectUpdateRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with updated information. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Projects" ], "summary": "Patch Project - update only values in request", "operationId": "ProjectsPatchProject", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, workflow will be processed", "schema": { "type": "boolean", "description": "If true, workflow will be processed", "default": false } } ], "requestBody": { "description": "Project patches. Properties with value will be updated", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Project patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/partner/{businessCustomerId}": { "put": { "tags": [ "Projects" ], "summary": "Add partner to project", "operationId": "ProjectsAddPartnerToProject", "parameters": [ { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "businessCustomerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with updated information. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/partner": { "delete": { "tags": [ "Projects" ], "summary": "Delete partner from project", "operationId": "ProjectsDeletePartnerFromProject", "parameters": [ { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with updated information. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/GetProjectTypes": { "get": { "tags": [ "Projects" ], "summary": "Get all project types", "operationId": "ProjectsGetProjectTypes", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Projects found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } } } }, "404": { "description": "No project types found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/AddCustomerToProject": { "post": { "tags": [ "Projects" ], "summary": "Add customer info to a project", "operationId": "ProjectsAddCustomerToProject", "requestBody": { "description": "Project containing customer object to store", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new customer. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Project not found" } } } }, "/api/Projects/AddBusinessCustomerToProject": { "post": { "tags": [ "Projects" ], "summary": "Add existing business customer info to a project", "operationId": "ProjectsAddBusinessCustomerToProject", "parameters": [ { "name": "projectId", "in": "query", "description": "ID of project", "required": true, "schema": { "type": "string", "description": "ID of project" } }, { "name": "businessCustomerId", "in": "query", "description": "ID of business customer", "required": true, "schema": { "type": "string", "description": "ID of business customer" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new customer. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "404": { "description": "Business customer not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/AddStoreToProject": { "post": { "tags": [ "Projects" ], "summary": "Add store id to a project", "operationId": "ProjectsAddStoreToProject", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, workflow will be processed", "schema": { "type": "boolean", "description": "If true, workflow will be processed", "default": true } } ], "requestBody": { "description": "Project containing store id", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new store. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Project not found" } } } }, "/api/Projects/AddFormElementsToProject": { "post": { "tags": [ "Projects" ], "summary": "Add information (key, value) to a project", "operationId": "ProjectsAddFormElementsToProject", "requestBody": { "description": "Project containing form data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with form elements. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Invalid project in request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Project not found" } } } }, "/api/Projects/Assets/GetAssets": { "get": { "tags": [ "Projects | Assets" ], "summary": "Get project assets", "description": "Get project assets by asset IDs", "operationId": "ProjectsGetAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning assets", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Projects/{projectId}/Invoices": { "get": { "tags": [ "Projects" ], "summary": "Get all invoices associated with project", "operationId": "ProjectsGetInvoicesForProject", "parameters": [ { "name": "projectId", "in": "path", "description": "Project identification", "required": true, "schema": { "type": "string", "description": "Project identification", "nullable": true } }, { "name": "page", "in": "query", "description": "Current page of the search request. Minimum 1.", "schema": { "type": "integer", "description": "Current page of the search request. Minimum 1.", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Max 100. Minimum 1.", "schema": { "type": "integer", "description": "Max 100. Minimum 1.", "format": "int32", "default": 20 } }, { "name": "isPaid", "in": "query", "description": "Add filter on payment-status", "schema": { "type": "boolean", "description": "Add filter on payment-status", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Invoices found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumInvoiceOmniumSearchResult" } } } }, "400": { "description": "Parameters are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "No invoices found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Assets/AddAsset/{projectId}": { "post": { "tags": [ "Projects | Assets" ], "summary": "Add asset to project from stream", "description": "Add new project asset from stream", "operationId": "ProjectsAddAsset", "parameters": [ { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "fileName", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAsset" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Projects/Assets/AddAssets/{projectId}": { "post": { "tags": [ "Projects | Assets" ], "summary": "Add assets to project", "description": "Add new project assets", "operationId": "ProjectsAddAssets", "parameters": [ { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset added successfully" }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Projects/Assets/UpdateAssets": { "post": { "tags": [ "Projects | Assets" ], "summary": "Update asset to project", "description": "Update existing project assets", "operationId": "ProjectsUpdateAssets", "parameters": [ { "name": "projectId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset updated successfully", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" } } } } }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Asset ids missing" } } } }, "/api/Projects/Assets/DeleteAssets": { "delete": { "tags": [ "Projects | Assets" ], "summary": "Delete assets from projects", "description": "Delete project assets by asset IDs", "operationId": "ProjectsDeleteAssets", "parameters": [ { "name": "assetIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset deleted successfully" }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Project ID or url missing" } } } }, "/api/Projects/Assets/DeleteAssetsFromProject": { "delete": { "tags": [ "Projects | Assets" ], "summary": "Delete all assets from project", "description": "Delete all assets on a project by project ID", "operationId": "ProjectsDeleteAssetsFromProject", "parameters": [ { "name": "projectId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Asset deleted successfully" }, "404": { "description": "Project does not exist", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Project ID or url missing" } } } }, "/api/Projects/AddCommentToProject": { "post": { "tags": [ "Obsolete" ], "summary": "Add partner comment to a project", "description": "OBSOLETE - Use 'api/Comments/Add' instead", "operationId": "ProjectsAddCommentToProject", "requestBody": { "description": "Partner comment to add to project", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new comment. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid project in request" }, "404": { "description": "Project not found" } }, "deprecated": true } }, "/api/Projects/{projectId}/customerComment/{commentId}": { "patch": { "tags": [ "Obsolete" ], "summary": "Update customer comment on a project", "description": "OBSOLETE - Use 'api/Comments/Update' instead", "operationId": "ProjectsUpdateCustomerComment", "parameters": [ { "name": "projectId", "in": "path", "description": "ProjectId of the comment's project", "required": true, "schema": { "type": "string", "description": "ProjectId of the comment's project", "nullable": true } }, { "name": "commentId", "in": "path", "description": "Id of comment to update", "required": true, "schema": { "type": "string", "description": "Id of comment to update", "nullable": true } } ], "requestBody": { "description": "Customer comment to update on project", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with the updated version of the customer comment. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid project in request" }, "404": { "description": "Project not found" } }, "deprecated": true } }, "/api/Projects/{projectId}/partnerComment": { "put": { "tags": [ "Obsolete" ], "summary": "Add partner comment to a project", "description": "OBSOLETE - Use 'api/Comments/Add' instead", "operationId": "ProjectsAddPartnerCommentToProject", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID to add comment to", "required": true, "schema": { "type": "string", "description": "Project ID to add comment to", "nullable": true } }, { "name": "emailRecipient", "in": "query", "description": "E-mail address if comment should be sent by e-mail", "schema": { "type": "string", "description": "E-mail address if comment should be sent by e-mail", "nullable": true } }, { "name": "smsRecipient", "in": "query", "description": "Phone number if comment should be sent by SMS", "schema": { "type": "string", "description": "Phone number if comment should be sent by SMS", "nullable": true } } ], "requestBody": { "description": "Partner comment to add to project", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new partner comment. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid project in request" }, "404": { "description": "Project not found" } }, "deprecated": true } }, "/api/Projects/{projectId}/partnerComment/{commentId}": { "patch": { "tags": [ "Obsolete" ], "summary": "Update partner comment on a project", "description": "OBSOLETE - Use 'api/Comments/Update' instead", "operationId": "ProjectsUpdatePartnerComment", "parameters": [ { "name": "projectId", "in": "path", "description": "ProjectId of the comment's project", "required": true, "schema": { "type": "string", "description": "ProjectId of the comment's project", "nullable": true } }, { "name": "commentId", "in": "path", "description": "Id of comment to update", "required": true, "schema": { "type": "string", "description": "Id of comment to update", "nullable": true } } ], "requestBody": { "description": "Partner comment to update on project", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with the updated version of the partner comment. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid project in request" }, "404": { "description": "Project not found" } }, "deprecated": true } }, "/api/Projects/{projectId}/customerComment": { "put": { "tags": [ "Obsolete" ], "summary": "Add customer comment to project", "description": "OBSOLETE - Use 'api/Comments/Add' instead", "operationId": "ProjectsAddCustomerCommentToProject", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID to add customer comment to", "required": true, "schema": { "type": "string", "description": "Project ID to add customer comment to", "nullable": true } }, { "name": "emailRecipient", "in": "query", "description": "E-mail address if comment should be sent by e-mail", "schema": { "type": "string", "description": "E-mail address if comment should be sent by e-mail", "nullable": true } }, { "name": "smsRecipient", "in": "query", "description": "Phone number if comment should be sent by SMS", "schema": { "type": "string", "description": "Phone number if comment should be sent by SMS", "nullable": true } } ], "requestBody": { "description": "Customer comment to add to project", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project is saved with new customer comment. Updated project is returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid project in request" }, "404": { "description": "Project not found" } }, "deprecated": true } }, "/api/Projects/Cancel": { "post": { "tags": [ "Projects" ], "summary": "Cancel project", "operationId": "ProjectsCancel", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectCancelRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectCancelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectCancelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectCancelRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/CancelByPartner": { "get": { "tags": [ "Obsolete" ], "summary": "Cancel project by partner", "operationId": "ProjectsCancelByPartner", "parameters": [ { "name": "projectId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "comment", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } } }, "deprecated": true } }, "/api/Projects/CancelByCustomer": { "get": { "tags": [ "Obsolete" ], "summary": "Cancel project by customer", "operationId": "ProjectsCancelByCustomer", "parameters": [ { "name": "projectId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "comment", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } } }, "deprecated": true } }, "/api/Projects/Decline": { "post": { "tags": [ "Projects" ], "summary": "Decline workflow step (go to previous step)", "operationId": "ProjectsDecline", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Accept": { "post": { "tags": [ "Projects" ], "summary": "Accept workflow step (go to next step)", "operationId": "ProjectsAccept", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/AcceptPartnerRequest": { "post": { "tags": [ "Projects" ], "summary": "Accept workflow step (go to next step)", "operationId": "ProjectsAcceptPartnerRequest", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/Partners": { "post": { "tags": [ "Projects" ], "summary": "Add partners to project", "operationId": "ProjectsAddPartners", "parameters": [ { "name": "businessCustomerIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete partners from project", "operationId": "ProjectsDeletePartners", "parameters": [ { "name": "businessCustomerIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string" }, "description": "", "nullable": true } }, { "name": "projectId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/DeclinePartnerRequest": { "post": { "tags": [ "Projects" ], "summary": "Decline workflow step (go to previous step)", "operationId": "ProjectsDeclinePartnerRequest", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/GoToWorkflowStep": { "post": { "tags": [ "Projects" ], "summary": "Go to specific workflow step", "operationId": "ProjectsGoToWorkflowStep", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumWorkflowStepRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/AddRejectingPartner": { "post": { "tags": [ "Projects" ], "summary": "Add partner to list of partners rejecting project", "operationId": "ProjectsAddRejectingPartner", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "rejectingPartnerId", "in": "query", "description": "PartnerId", "schema": { "type": "string", "description": "PartnerId", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Partner successfully added to list of rejecting partners" }, "400": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "" } } } }, "/api/Projects/{projectId}/RemoveRejectingPartner": { "delete": { "tags": [ "Projects" ], "summary": "Remove partner from list of partners rejecting project", "operationId": "ProjectsRemoveRejectingPartner", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "rejectingPartnerId", "in": "query", "description": "PartnerId", "schema": { "type": "string", "description": "PartnerId", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Partner successfully removed from list of rejecting partners" }, "400": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "" } } } }, "/api/Projects/Project/{projectId}/SendEmail": { "post": { "tags": [ "Projects" ], "summary": "Send E-mail", "operationId": "ProjectsSendEmail", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "description": "E-mail-message to send", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumEmailMessage" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Email is sent" }, "400": { "description": "Email is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Project/{projectId}/SendSms": { "post": { "tags": [ "Projects" ], "summary": "Send SMS", "operationId": "ProjectsSendSms", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "requestBody": { "description": "SMS-message to send", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSmsMessage" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "SMS is sent" }, "400": { "description": "SMS is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ChangeOrders/{projectChangeOrderId}": { "get": { "tags": [ "Projects | Change orders" ], "summary": "Get project change order", "description": "Get project change order by project ID and project change order ID.", "operationId": "ProjectsChangeOrdersGetProjectChangeOrder", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "changeOrderId", "in": "query", "description": "Project change order ID to get", "schema": { "type": "string", "description": "Project change order ID to get", "nullable": true } }, { "name": "projectChangeOrderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Projects | Change orders" ], "summary": "Update project change order", "description": "Delete project change order by project and project change order ID.", "operationId": "ProjectsChangeOrdersProjectChangeOrderDelete", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "projectChangeOrderId", "in": "path", "description": "Project change order ID to delete", "required": true, "schema": { "type": "string", "description": "Project change order ID to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ChangeOrders": { "post": { "tags": [ "Projects | Change orders" ], "summary": "Add project change order", "description": "Add project change order by project ID.", "operationId": "ProjectsChangeOrdersProjectChangeOrderAdd", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project change order to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Projects | Change orders" ], "summary": "Update project change orders", "description": "Update or add project change order by project ID. Projects change orders with same ID will be overriden.", "operationId": "ProjectsChangeOrdersProjectChangeOrdersUpdate", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project change order to add or update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ChangeOrders/AddMany": { "post": { "tags": [ "Projects | Change orders" ], "summary": "Update many project change orders", "description": "Add project change orders by project ID.", "operationId": "ProjectsChangeOrdersProjectChangeOrdersAddMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project change orders to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ChangeOrders/UpdateMany": { "put": { "tags": [ "Projects | Change orders" ], "summary": "Update many project change orders", "description": "Update or add project change orders by project ID. Projects change orders with same ID will be overriden.", "operationId": "ProjectsChangeOrdersProjectChangeOrderUpdateMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project change orders to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ProjectParts/{projectPartId}": { "get": { "tags": [ "Projects | Parts" ], "summary": "Get project part", "description": "Get project part by project ID and project part ID.", "operationId": "ProjectsPartsGetProjectPart", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "projectPartId", "in": "path", "description": "Project part ID to get", "required": true, "schema": { "type": "string", "description": "Project part ID to get", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Projects | Parts" ], "summary": "Update project part", "description": "Delete project part by project and project part ID.", "operationId": "ProjectsPartsProjectPartDelete", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "projectPartId", "in": "path", "description": "Project part ID to delete", "required": true, "schema": { "type": "string", "description": "Project part ID to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ProjectParts": { "post": { "tags": [ "Projects | Parts" ], "summary": "Add project part", "description": "Add project part by project ID.", "operationId": "ProjectsPartsProjectPartAdd", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project part to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Projects | Parts" ], "summary": "Update project part", "description": "Update or add project part by project ID. Projects parts with same ID will be overriden.", "operationId": "ProjectsPartsProjectPartUpdate", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project part to add or update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectPart" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ProjectParts/AddMany": { "post": { "tags": [ "Projects | Parts" ], "summary": "Update many project parts", "description": "Add project parts by project ID.", "operationId": "ProjectsPartsProjectPartAddMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project parts to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ProjectParts/{projectPartId}/UpdateProjectTask": { "put": { "tags": [ "Projects | Parts" ], "summary": "Update task on project part", "description": "Update or add task on project part.", "operationId": "ProjectsPartsUpdateProjectTask", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "projectPartId", "in": "path", "description": "Project part ID", "required": true, "schema": { "type": "string", "description": "Project part ID", "nullable": true } } ], "requestBody": { "description": "Project task to add or update on project part", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTask" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTask" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTask" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTask" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/ProjectParts/UpdateMany": { "put": { "tags": [ "Projects | Parts" ], "summary": "Update many project parts", "description": "Update or add project parts by project ID. Projects parts with same ID will be overriden.", "operationId": "ProjectsPartsProjectPartUpdateMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project parts to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/Transactions/{projectTransactionId}": { "get": { "tags": [ "Projects | Transactions" ], "summary": "Get project transaction", "description": "Get project transaction by project ID and project transaction ID.", "operationId": "ProjectsTransactionsGetProjectTransaction", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "transactionId", "in": "query", "description": "Project transaction ID to get", "schema": { "type": "string", "description": "Project transaction ID to get", "nullable": true } }, { "name": "projectTransactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Projects | Transactions" ], "summary": "Update project transaction", "description": "Delete project transaction by project and project transaction ID.", "operationId": "ProjectsTransactionsProjectTransactionDelete", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "projectTransactionId", "in": "path", "description": "Project transaction ID to delete", "required": true, "schema": { "type": "string", "description": "Project transaction ID to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/Transactions": { "post": { "tags": [ "Projects | Transactions" ], "summary": "Add project transaction", "description": "Add project transaction by project ID.", "operationId": "ProjectsTransactionsProjectTransactionAdd", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project transaction to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Projects | Transactions" ], "summary": "Update project transactions", "description": "Update or add project transaction by project ID. Projects transactions with same ID will be overriden.", "operationId": "ProjectsTransactionsProjectTransactionsUpdate", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project transaction to add or update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTransaction" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Transactions/Sum": { "post": { "tags": [ "Projects | Transactions" ], "summary": "Search for projects and return a sum over all transactions", "description": "Get project transaction summaries from projectSearchParams.", "operationId": "ProjectsTransactionsGetTransactionSummary", "requestBody": { "description": "Search request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransactionSummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransactionSummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransactionSummary" } } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/Transactions/AddMany": { "post": { "tags": [ "Projects | Transactions" ], "summary": "Update many project transactions", "description": "Add project transactions by project ID.", "operationId": "ProjectsTransactionsProjectTransactionsAddMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project transactions to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/{projectId}/Transactions/UpdateMany": { "put": { "tags": [ "Projects | Transactions" ], "summary": "Update many project transactions", "description": "Update or add project transactions by project ID. Projects transactions with same ID will be overriden.", "operationId": "ProjectsTransactionsProjectTransactionUpdateMany", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } } ], "requestBody": { "description": "Project transactions to add or update", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions to add or update", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProject" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Versions/{projectId}": { "get": { "tags": [ "Projects | Versions" ], "summary": "Get list of all version items.", "operationId": "ProjectsVersionsVersionList", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID to fetch version list for", "required": true, "schema": { "type": "string", "description": "Project ID to fetch version list for", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVersionListItem" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/Versions/{projectId}/{versionId}": { "get": { "tags": [ "Projects | Versions" ], "summary": "Get specific project version", "operationId": "ProjectGetVersion", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "string", "description": "Project ID", "nullable": true } }, { "name": "versionId", "in": "path", "description": "Version ID to fetch", "required": true, "schema": { "type": "string", "description": "Version ID to fetch", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumVersion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumVersion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectOmniumVersion" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProjectTypes/GetAll": { "get": { "tags": [ "Projects | Project types" ], "summary": "Get all project types", "operationId": "ProjectTypesGetAll", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } } } }, "404": { "description": "Not Found" }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ProjectTypes": { "patch": { "tags": [ "Projects | Project types" ], "summary": "Patch Project Type - update only values in request", "operationId": "ProjectTypesPatchProject", "requestBody": { "description": "Project type patches. Properties with value will be updated", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypePatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypePatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumProjectTypePatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Project Type updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProjectType" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectType" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProjectType" } } } }, "400": { "description": "Project Type patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/{id}": { "get": { "tags": [ "Promotions" ], "summary": "Returns a single promotion", "operationId": "PromotionsGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of the promotion to return", "required": true, "schema": { "type": "string", "description": "ID of the promotion to return", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPromotion" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotion" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotion" } } } }, "404": { "description": "The promotion was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/Search": { "post": { "tags": [ "Promotions" ], "summary": "Search for promotions", "description": "Sample request for getting promotions that are valid during the time interval 2024-10-01 - 2024-10-07\r\n \r\n POST /api/Promotions/Search\r\n {\r\n {\r\n \"activatedBeforeDate\": \"2024-10-01T00:00:00\",\r\n \"endedAfterDate\": \"2024-10-07T00:00:00\",\r\n \"marketIds\": [\"NOR\"],\r\n \"page\":1,\r\n \"take\":10\r\n }\r\n }\r\n \r\n \r\nSample request for getting promotions that will become active during the time interval 2024-10-01 - 2024-10-07, for shipping and order amount promotion types\r\n \r\n POST /api/Promotions/Search\r\n {\r\n {\r\n \"promotionTypes\": [\"ShippingPromotion\", \"OrderAmountPromotion\"],\r\n \"activeFrom\": \"2024-10-01T00:00:00\",\r\n \"activatedBeforeDate\": \"2024-10-07T00:00:00\",\r\n \"marketIds\": [\"NOR\"],\r\n \"page\": 1,\r\n \"take\": 10\r\n }\r\n }\r\n \r\nFor bulk extraction of large result sets, use POST /api/Promotions/Search/Scroll instead.", "operationId": "PromotionsSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/Search/Scroll": { "post": { "tags": [ "Promotions" ], "summary": "Search for promotions and open a scroll for bulk extraction of large result sets.", "description": "Returns the first batch of promotions together with a scrollId. Pass the scrollId to\r\nGET /api/Promotions/Scroll/{id} to fetch each subsequent batch, and keep scrolling until the\r\nresponse no longer contains a scrollId. ScrollSize controls the batch size (default 500, range 100-1000).\r\nScrolling is not intended for real time user requests, but rather for processing large amounts of data.\r\n \r\n POST /api/Promotions/Search/Scroll\r\n {\r\n {\r\n \"marketIds\": [\"NOR\"],\r\n \"scrollSize\": 500\r\n }\r\n }", "operationId": "PromotionsSearchScroll", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionScrollSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionScrollSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionScrollSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionScrollSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/Scroll/{id}": { "get": { "tags": [ "Promotions" ], "summary": "Scroll promotions is used to get a large amount of promotions.", "description": "The scroll Id can be obtained from a scroll search request.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PromotionsScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request for the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request for the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionOmniumResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/GenerateSingleUsagePromotionCoupons/{id}": { "get": { "tags": [ "Promotions" ], "summary": "Generate n number for promotion coupon codes. The codes will be only for single usage", "operationId": "PromotionsGenerateSingleUsagePromotionCoupons", "parameters": [ { "name": "id", "in": "path", "description": "Promotion id", "required": true, "schema": { "type": "string", "description": "Promotion id", "nullable": true } }, { "name": "numberOfCouponsToGenerate", "in": "query", "description": "Number of coupon codes to generate. Max is 1000", "required": true, "schema": { "type": "integer", "description": "Number of coupon codes to generate. Max is 1000", "format": "int32" } }, { "name": "couponCharLength", "in": "query", "description": "Optional: Length (number of characters) of the generate coupon code. Default and max length is 32", "schema": { "maximum": 32, "minimum": 0, "type": "integer", "description": "Optional: Length (number of characters) of the generate coupon code. Default and max length is 32", "format": "int32" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions": { "post": { "tags": [ "Promotions" ], "summary": "Add a new promotion", "operationId": "PromotionsAdd", "requestBody": { "description": "OmniumPromotion", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Promotions" ], "summary": "Patch update a promotion", "operationId": "PromotionsPatch", "requestBody": { "description": "OmniumPromotion", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatchUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatchUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPromotionPatchUpdateResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/{id}/Convert": { "post": { "tags": [ "Promotions" ], "summary": "Manually trigger conversion of a promotion's prices to regular prices with a configurable tag.\r\nThis creates a new regular price list from the promotion's price list, activates it, \r\nand deactivates the promotion. Used for immediate conversion without waiting for the scheduled task.", "operationId": "PromotionsConvert", "parameters": [ { "name": "id", "in": "path", "description": "ID of the promotion to convert", "required": true, "schema": { "type": "string", "description": "ID of the promotion to convert", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Conversion result" }, "404": { "description": "The promotion was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/{promotionId}": { "delete": { "tags": [ "Promotions" ], "summary": "Delete a promotion", "operationId": "PromotionsDelete", "parameters": [ { "name": "promotionId", "in": "path", "description": "ID of the promotion to delete", "required": true, "schema": { "type": "string", "description": "ID of the promotion to delete", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Promotions/GetPotentialDiscounts": { "get": { "tags": [ "Promotions" ], "summary": "Get potential-discount hints for a cart: promotions that would apply if more items were added,\r\nan order amount was met, a club member was attached, or a coupon was entered.", "operationId": "PromotionsGetPotentialDiscounts", "parameters": [ { "name": "cartId", "in": "query", "description": "ID of the cart to evaluate", "schema": { "type": "string", "description": "ID of the cart to evaluate", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPotentialDiscountHint" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPotentialDiscountHint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPotentialDiscountHint" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "The cart was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PropertyOptions": { "get": { "tags": [ "Settings | Property Options" ], "summary": "Returns all options in a group, sorted by SortOrder ascending.", "operationId": "PropertyOptionsGetByGroup", "parameters": [ { "name": "group", "in": "query", "description": "Group name (case-insensitive).", "schema": { "type": "string", "description": "Group name (case-insensitive).", "nullable": true } }, { "name": "includeInactive", "in": "query", "description": "Include options where IsActive is false (defaults to false).", "schema": { "type": "boolean", "description": "Include options where IsActive is false (defaults to false).", "default": false } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Options returned.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } } }, "400": { "description": "Group is required.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "post": { "tags": [ "Settings | Property Options" ], "summary": "Create a new property option.", "operationId": "PropertyOptionsPost", "requestBody": { "description": "The option to create.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Option created.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } }, "400": { "description": "Invalid input.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PropertyOptions/groups": { "get": { "tags": [ "Settings | Property Options" ], "summary": "Returns the list of distinct group display names.", "operationId": "PropertyOptionsGetGroups", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Group names returned.", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/PropertyOptions/Search": { "post": { "tags": [ "Settings | Property Options" ], "summary": "Search property options with paging. Use this to look up specific options by id, group, or other filters\r\nwithout being limited by the per-group cap on the basic GET endpoint.", "operationId": "PropertyOptionsSearch", "requestBody": { "description": "Search filters and paging parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search results returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } } } }, "400": { "description": "Invalid request (e.g. Take exceeds the maximum of 1000).", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PropertyOptions/Scroll": { "post": { "tags": [ "Settings | Property Options" ], "summary": "Start a scroll over all property options matching the supplied filters. Use this when a group\r\nhas more than ~20,000 options and offset paging via Search is not viable. Take is forced to 1000\r\nand the client paging fields on the request body are ignored.", "operationId": "PropertyOptionsScrollSearch", "requestBody": { "description": "Search filters. Page and Take are ignored.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "First batch of results and a ScrollId. When ScrollId is null, all results have been returned.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } } } }, "400": { "description": "Invalid request.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PropertyOptions/Scroll/{id}": { "get": { "tags": [ "Settings | Property Options" ], "summary": "Continue a scroll started by POST /api/PropertyOptions/Scroll. Repeat with the returned ScrollId\r\nuntil ScrollId is null, which means all results have been returned and the server-side scroll has been cleared.", "operationId": "PropertyOptionsScroll", "parameters": [ { "name": "id", "in": "path", "description": "ScrollId returned by the previous Scroll call.", "required": true, "schema": { "type": "string", "description": "ScrollId returned by the previous Scroll call.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Next batch of results. ScrollId is null when no more pages remain.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOptionOmniumResult" } } } } } } }, "/api/PropertyOptions/AddMany": { "post": { "tags": [ "Settings | Property Options" ], "summary": "Create multiple property options in a single request.", "operationId": "PropertyOptionsAddMany", "requestBody": { "description": "The options to create.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" }, "description": "The options to create.", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" }, "description": "The options to create.", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" }, "description": "The options to create.", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" }, "description": "The options to create.", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Options created.", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } } }, "400": { "description": "Invalid input.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PropertyOptions/{id}": { "put": { "tags": [ "Settings | Property Options" ], "summary": "Update a property option. Group key is immutable; only Value, SortOrder, and IsActive can change.", "operationId": "PropertyOptionsPut", "parameters": [ { "name": "id", "in": "path", "description": "Id of the option to update.", "required": true, "schema": { "type": "string", "description": "Id of the option to update.", "nullable": true } } ], "requestBody": { "description": "The updated option payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Option updated.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPropertyOption" } } } }, "400": { "description": "Invalid input.", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Option not found.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Settings | Property Options" ], "summary": "Delete a property option. Does not modify any DefaultPropertyItem.PropertyOptionGroup references.", "operationId": "PropertyOptionsDelete", "parameters": [ { "name": "id", "in": "path", "description": "Id of the option to delete.", "required": true, "schema": { "type": "string", "description": "Id of the option to delete.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Option deleted." } } } }, "/api/PurchaseOrders/Query": { "post": { "tags": [ "Purchase Orders" ], "summary": "🧪 [Preview] Query purchase orders. Returns full purchase order models with explicit control over\r\nfilters, sorting, pagination and field selection.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nPrimary endpoint for fetching purchase orders: single lookups, filtered lists, and\r\npaginated UI queries. Pagination is capped at offset (Take * Page) of 10,000 — past that,\r\nuse POST /api/PurchaseOrders/Query/Scroll.\r\n \r\nAll filter fields are documented on the request schema below.\r\n \r\n### Examples\r\n \r\n**1. Specific purchase orders by ID.**\r\n```json\r\n{\r\n \"purchaseOrderIds\": [\"PO-123\", \"PO-456\"]\r\n}\r\n```\r\n \r\n**2. Filtered list with a tight payload** (recommended). Order lines are usually the bulk\r\nof the document — exclude them when you only need header data.\r\n```json\r\n{\r\n \"take\": 50,\r\n \"page\": 1,\r\n \"statuses\": [\"Sent\"],\r\n \"storeIds\": [\"store-1\"],\r\n \"sort\": [{ \"field\": \"created\", \"direction\": \"desc\" }],\r\n \"fields\": { \"exclude\": [\"purchaseOrderForm.lineItems\"] }\r\n}\r\n```\r\n \r\n**3. Only the fields you need.** The document `id` is always returned.\r\n```json\r\n{\r\n \"supplierId\": \"SUPPLIER-1\",\r\n \"fields\": { \"include\": [\"purchaseOrderNumber\", \"status\", \"total\"] }\r\n}\r\n```", "operationId": "PurchaseOrderQueryQuery", "requestBody": { "description": "Query request with filters, pagination, and field selection", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderQueryRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Query successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumQueryResult" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "x-preview": true } }, "/api/PurchaseOrders/Query/Scroll": { "post": { "tags": [ "Purchase Orders" ], "summary": "🧪 [Preview] Initiate a scroll session for retrieving large purchase order datasets.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nBulk extraction endpoint — full syncs to other systems (ERP, BI), data exports. Also\r\nrequired past the 10,000 offset cap on POST /Query.\r\n \r\nReturns a `scrollId` and the first batch. Pass `scrollId` to\r\nGET /api/PurchaseOrders/Query/Scroll/{scrollId} until it comes back null. Sessions expire\r\nafter 10 minutes of inactivity; per-tenant concurrency is capped.\r\n \r\nSame filter set as POST /Query (see request schema) and identical response shape — field\r\nselection applies to both the initial batch and continuations.\r\n \r\n### Canonical example\r\nDelta sync — every purchase order modified since the last run, without order lines:\r\n```json\r\n{\r\n \"modifiedFrom\": \"2026-01-08T10:15:00Z\",\r\n \"scrollSize\": 500,\r\n \"fields\": { \"exclude\": [\"purchaseOrderForm.lineItems\"] }\r\n}\r\n```", "operationId": "PurchaseOrderQueryQueryScroll", "requestBody": { "description": "Query request with filters and field selection", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderScrollQueryRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderScrollQueryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderScrollQueryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderScrollQueryRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Scroll initiated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } } } }, "400": { "description": "Invalid request parameters", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } }, "x-preview": true } }, "/api/PurchaseOrders/Query/Scroll/{scrollId}": { "get": { "tags": [ "Purchase Orders" ], "summary": "🧪 [Preview] Continue an active scroll session and fetch the next batch of purchase orders.", "description": "> **🧪 Preview** — early access! This endpoint is fully functional, but its shape may still change while we finalize it.\n\nCall repeatedly with the latest returned `scrollId` until it comes back null. Sessions\r\nexpire after 10 minutes of inactivity. See `POST /api/PurchaseOrders/Query/Scroll` for the\r\ninitiation endpoint and full request shape.", "operationId": "PurchaseOrderQueryScrollContinuation", "parameters": [ { "name": "scrollId", "in": "path", "description": "The scroll ID from the previous response (initial Scroll call or a prior continuation)", "required": true, "schema": { "type": "string", "description": "The scroll ID from the previous response (initial Scroll call or a prior continuation)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Scroll continuation successful", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumScrollableQueryResult" } } } } }, "x-preview": true } }, "/api/PurchaseOrders/{purchaseOrderId}": { "get": { "tags": [ "Purchase Orders" ], "summary": "Get purchase order", "operationId": "PurchaseOrdersGetPurchaseOrder", "parameters": [ { "name": "purchaseOrderId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Purchase Orders" ], "summary": "Patch purchase order", "description": "Patch purchase order", "operationId": "PurchaseOrdersPatch", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "Purchase order ID to patch", "required": true, "schema": { "type": "string", "description": "Purchase order ID to patch", "nullable": true } }, { "name": "updateAtpValues", "in": "query", "description": "If true ATP providers will calculate new ATP values based on the purchase order", "schema": { "type": "boolean", "description": "If true ATP providers will calculate new ATP values based on the purchase order" } } ], "requestBody": { "description": "Purchase order patch", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/Search": { "post": { "tags": [ "Purchase Orders" ], "summary": "Search purchase orders", "description": "Search purchase orders", "operationId": "PurchaseOrdersSearch", "requestBody": { "description": "Search request object for purchase orders", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PurchaseOrders/Scroll": { "post": { "tags": [ "Purchase Orders" ], "summary": "Scroll purchaseOrders by search", "description": "Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. \r\n Paging (take, page) is disabled for scroll searches.\r\n Sample request for a delta query using modified date and filtering on an order type:\r\n \r\n POST /api/PurchaseOrders/Scroll\r\n {\r\n \"ModifiedFrom\": \"2022-12-24T17:32:28Z\"\r\n }", "operationId": "PurchaseOrdersScrollSearch", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning orders", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } } } }, "400": { "description": "Search request invalid" } } } }, "/api/PurchaseOrders/Scroll/{id}": { "get": { "tags": [ "Purchase Orders" ], "summary": "Scroll purchaseOrders is used to get a large amount of customers.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "PurchaseOrdersScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderOmniumResult" } } } } } } }, "/api/PurchaseOrders": { "post": { "tags": [ "Purchase Orders" ], "summary": "Add a purchase order", "operationId": "PurchaseOrdersPost", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "", "schema": { "type": "boolean", "description": "" } } ], "requestBody": { "description": "Purchase order to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Purchase Orders" ], "summary": "Update purchase order", "description": "Update purchase order", "operationId": "PurchaseOrdersUpdate", "parameters": [ { "name": "updateAtpValues", "in": "query", "description": "If true ATP providers will calculate new ATP values based on the purchase order", "schema": { "type": "boolean", "description": "If true ATP providers will calculate new ATP values based on the purchase order" } } ], "requestBody": { "description": "Purchase order", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/UpdateAndRunWorkflow": { "post": { "tags": [ "Purchase Orders | Workflows" ], "summary": "Update purchase order and run workflow", "description": "Update purchase order", "operationId": "PurchaseOrdersUpdateAndRunWorkflow", "parameters": [ { "name": "updateAtpValues", "in": "query", "description": "If true ATP providers will calculate new ATP values based on the purchase order", "schema": { "type": "boolean", "description": "If true ATP providers will calculate new ATP values based on the purchase order" } } ], "requestBody": { "description": "Purchase order", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/{purchaseOrderId}/UpdateStatus": { "post": { "tags": [ "Purchase Orders | Workflows" ], "summary": "Update status and run workflow for a purchase order", "description": "If you need to update status on a purchase order, set the corresponding. The workflow request object allows you to add expected delivery date.\r\n
\r\nIf you do not wish to automatically run the workflow for the purchase order, you can specify this using \"skipRunWorkflow:true\".\r\n

\r\nBasic example on how you would update status to \"Confirmed\" for an existing order:\r\n \r\n POST /api/purchaseOrders/{purchaseOrderId}/UpdateStatus\r\n {\r\n \"status\": \"Confirmed\",\r\n \"expectedDeliveryDate\": 2024-01-01\r\n }", "operationId": "PurchaseOrdersRunWorkflow", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "The ID of the purchase order", "required": true, "schema": { "type": "string", "description": "The ID of the purchase order", "nullable": true } } ], "requestBody": { "description": "Information about the", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderWorkflowExecutionResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Purchase order to update was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/UpdateMany": { "put": { "tags": [ "Purchase Orders" ], "summary": "Update many purchase orders", "description": "Update many purchase orders", "operationId": "PurchaseOrdersUpdateMany", "requestBody": { "description": "Purchase orders", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Purchase orders", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Purchase orders", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Purchase orders", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Purchase orders", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PurchaseOrders/{id}": { "delete": { "tags": [ "Purchase Orders" ], "summary": "Delete purchase order", "operationId": "PurchaseOrdersDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Purchase order deleted" }, "404": { "description": "Purchase order not found" }, "409": { "description": "Conflict" }, "400": { "description": "Invalid request" } } }, "post": { "tags": [ "Purchase Orders" ], "summary": "Update ATP values", "operationId": "PurchaseOrdersUpdateAtpValues", "parameters": [ { "name": "id", "in": "path", "description": "Purchase order ID", "required": true, "schema": { "type": "string", "description": "Purchase order ID", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "ATP values updated" }, "404": { "description": "Purchase order not found" }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/{purchaseOrderId}/AddPublicPurchaseOrderComment": { "post": { "tags": [ "Purchase Orders" ], "summary": "Add public purchase order comment", "description": "Add public purchase order comment", "operationId": "PurchaseOrdersAddPublicPurchaseOrderComment", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/{purchaseOrderId}/AddInternalPurchaseOrderComment": { "post": { "tags": [ "Purchase Orders" ], "summary": "Add internal purchase order comment", "description": "Add internal purchaser order comment", "operationId": "PurchaseOrdersAddInternalPurchaseOrderComment", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumComment" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" } } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/Extended/{purchaseOrderId}": { "get": { "tags": [ "Purchase Orders" ], "summary": "Get extended purchase order", "operationId": "PurchaseOrdersGetExtendedPurchaseOrder", "parameters": [ { "name": "purchaseOrderId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderExtendedModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderExtendedModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrderExtendedModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/PurchaseOrders/{purchaseOrderId}/Merge": { "post": { "tags": [ "Purchase Orders" ], "summary": "Merge a purchase order into another purchase order", "operationId": "PurchaseOrdersMerge", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "Source purchase order ID (will be merged and deleted)", "required": true, "schema": { "type": "string", "description": "Source purchase order ID (will be merged and deleted)", "nullable": true } } ], "requestBody": { "description": "Merge request containing the destination purchase order ID", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumMergePurchaseOrderRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumMergePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumMergePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumMergePurchaseOrderRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/{purchaseOrderLineItemId}/Reservations": { "get": { "tags": [ "Purchase Orders" ], "summary": "Search sales order reservations by purchase order line item ID", "operationId": "PurchaseOrdersSearchReservations", "parameters": [ { "name": "purchaseOrderLineItemId", "in": "path", "description": "Purchase order line item ID", "required": true, "schema": { "type": "string", "description": "Purchase order line item ID", "nullable": true } }, { "name": "page", "in": "query", "description": "Page number (default 1)", "schema": { "type": "integer", "description": "Page number (default 1)", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (default 10, max 100)", "schema": { "type": "integer", "description": "Page size (default 10, max 100)", "format": "int32", "default": 10 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderOmniumSearchResult" } } } } } } }, "/api/PurchaseOrders/{purchaseOrderId}/OrderLines/Split": { "post": { "tags": [ "Purchase Orders" ], "summary": "Split one or more purchase order lines", "operationId": "PurchaseOrdersSplitOrderLines", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "Purchase order ID (Required)", "required": true, "schema": { "type": "string", "description": "Purchase order ID (Required)", "nullable": true } } ], "requestBody": { "description": "List of split requests specifying quantities and allocations for each line to split", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSplitPurchaseOrderLine" }, "description": "List of split requests specifying quantities and allocations for each line to split", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSplitPurchaseOrderLine" }, "description": "List of split requests specifying quantities and allocations for each line to split", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSplitPurchaseOrderLine" }, "description": "List of split requests specifying quantities and allocations for each line to split", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSplitPurchaseOrderLine" }, "description": "List of split requests specifying quantities and allocations for each line to split", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Purchase order lines split successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "404": { "description": "Purchase order or line was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid split request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/PurchaseOrders/{purchaseOrderId}/OrderLines/{lineItemId}/Cancel": { "post": { "tags": [ "Purchase Orders" ], "summary": "Cancel purchase order line", "operationId": "PurchaseOrdersCancelOrderLine", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "Purchase order ID (Required)", "required": true, "schema": { "type": "string", "description": "Purchase order ID (Required)", "nullable": true } }, { "name": "lineItemId", "in": "path", "description": "Purchase order line ID (Required)", "required": true, "schema": { "type": "string", "description": "Purchase order line ID (Required)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Purchase order line cancelled successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "404": { "description": "Purchase order line was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" }, "400": { "description": "Purchase order line could not be cancelled" } } } }, "/api/PurchaseOrders/{purchaseOrderId}/OrderLines/Cancel": { "post": { "tags": [ "Purchase Orders" ], "summary": "Cancel multiple purchase order lines", "operationId": "PurchaseOrdersCancelOrderLines", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "Purchase order ID (Required)", "required": true, "schema": { "type": "string", "description": "Purchase order ID (Required)", "nullable": true } } ], "requestBody": { "description": "Line item IDs to cancel", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCancelPurchaseOrderLinesRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCancelPurchaseOrderLinesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCancelPurchaseOrderLinesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCancelPurchaseOrderLinesRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Purchase order lines cancelled successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } } } }, "400": { "description": "No line item IDs were provided", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Purchase order was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict" } } } }, "/api/Ratings": { "put": { "tags": [ "Ratings" ], "summary": "Add or save a rating. If ID is null, it will be created.", "operationId": "RatingsPut", "requestBody": { "description": "The rating object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumRating" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRating" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRating" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumRating" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Ratings/{id}": { "delete": { "tags": [ "Ratings" ], "summary": "Deletes a single rating from the OMS", "operationId": "RatingsDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Ratings/GetRatings": { "get": { "tags": [ "Ratings" ], "summary": "Get ratings for an Omnium object", "operationId": "RatingsGetRatings", "parameters": [ { "name": "type", "in": "query", "description": "The object class to get ratings from (e.g. BusinessCustomer, Product, etc)", "schema": { "type": "string", "description": "The object class to get ratings from (e.g. BusinessCustomer, Product, etc)", "nullable": true } }, { "name": "objectId", "in": "query", "description": "The object id to get ratings from (e.g. 12345)", "schema": { "type": "string", "description": "The object id to get ratings from (e.g. 12345)", "nullable": true } }, { "name": "page", "in": "query", "description": "Page number", "schema": { "type": "integer", "description": "Page number", "format": "int32", "default": 1 } }, { "name": "take", "in": "query", "description": "Number of elements", "schema": { "type": "integer", "description": "Number of elements", "format": "int32", "default": 10 } }, { "name": "ignoreRequiresAttention", "in": "query", "description": "Ignore ratings that needs attention by customer service (default: true)", "schema": { "type": "boolean", "description": "Ignore ratings that needs attention by customer service (default: true)", "default": true } }, { "name": "parentObjectId", "in": "query", "description": "The parent object id to get ratings for. If both objectId and parentObjectd has value, \"or\" query will be used", "schema": { "type": "string", "description": "The parent object id to get ratings for. If both objectId and parentObjectd has value, \"or\" query will be used", "nullable": true } }, { "name": "includeOnlyRatingsWithComments", "in": "query", "description": "Return only ratings with comments", "schema": { "type": "boolean", "description": "Return only ratings with comments", "default": false } } ], "requestBody": { "description": "Filter ratings by markets", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter ratings by markets", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter ratings by markets", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter ratings by markets", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter ratings by markets", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Ratings/Search": { "post": { "tags": [ "Ratings" ], "summary": "Search for ratings", "operationId": "RatingsSearchRatings", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Ratings/ScrollSearch": { "post": { "tags": [ "Ratings" ], "summary": "Scroll large amounts of ratings", "description": "The scroll Id obtained here should be passed to the scroll endpoint to continue the scroll operation (fetch the next page of results). Page/take not relevant default is 5000 ratings in each batch.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "RatingsScrollSearchRatings", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRatingRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Ratings/Scroll/{id}": { "get": { "tags": [ "Ratings" ], "summary": "Scroll ratings is used to get a large amount of ratings.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "RatingsScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRatingOmniumResult" } } } } } } }, "/api/Ratings/GetAverageRatings": { "get": { "tags": [ "Ratings" ], "summary": "Get average rating for an Omnium object", "operationId": "RatingsGetAverageRatings", "parameters": [ { "name": "type", "in": "query", "description": "The object class to get ratings from (e.g. BusinessCustomer, Product, etc)", "schema": { "type": "string", "description": "The object class to get ratings from (e.g. BusinessCustomer, Product, etc)", "nullable": true } }, { "name": "objectId", "in": "query", "description": "The object id to get ratings from (e.g. 12345)", "schema": { "type": "string", "description": "The object id to get ratings from (e.g. 12345)", "nullable": true } }, { "name": "ignoreRequiresAttention", "in": "query", "description": "Ignore ratings that needs attention by customer service", "schema": { "type": "boolean", "description": "Ignore ratings that needs attention by customer service", "default": true } }, { "name": "parentObjectId", "in": "query", "description": "The parent object id to get ratings for. If both objectId and parentObjectd has value, \"or\" query will be used", "schema": { "type": "string", "description": "The parent object id to get ratings for. If both objectId and parentObjectd has value, \"or\" query will be used", "nullable": true } } ], "requestBody": { "description": "Filter by marketIds", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by marketIds", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by marketIds", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by marketIds", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by marketIds", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "number", "format": "double" } }, "application/json": { "schema": { "type": "number", "format": "double" } }, "text/json": { "schema": { "type": "number", "format": "double" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Recommendations/Search": { "post": { "tags": [ "Products | Recommendations" ], "summary": "Get products recommendations based on products IDs, customer ID, boosted properties and/or included/excluded products properties.", "operationId": "RecommendationsSearchRecommendations", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRecommendationsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRecommendationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRecommendationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSearchRecommendationsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } } } } } } }, "/api/Recommendations/GetTopSellers": { "post": { "tags": [ "Products | Recommendations" ], "summary": "Get top selling products recommendations", "operationId": "RecommendationsGetTopSellingProductsRecommendations", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumGetTopSellingProductsRecommendationsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGetTopSellingProductsRecommendationsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGetTopSellingProductsRecommendationsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumGetTopSellingProductsRecommendationsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRecommendationsResult" } } } } } } }, "/api/Rentals/GetRentalProducts": { "get": { "tags": [ "Products | Rentals" ], "summary": "Get rental products in a certain store", "operationId": "RentalsGetRentalProducts", "parameters": [ { "name": "storeId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental products found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } } } } } } }, "/api/Rentals/GetRentalSourceProducts": { "get": { "tags": [ "Products | Rentals" ], "summary": "Get rental source products in a certain store", "operationId": "RentalsGetRentalSourceProducts", "parameters": [ { "name": "storeId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental products found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" } } } } } } } }, "/api/Rentals/GetAvailability": { "post": { "tags": [ "Products | Rentals" ], "summary": "Get availability for the given source product(s) or rental product(s) in a given timespan.\r\nIf fields are left blank, they will match all rental products.", "operationId": "RentalsGetAvailability", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Availability and bookings successfully found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalAvailabilityResult" } } } } } } }, "/api/Rentals/CreateRentalProducts": { "post": { "tags": [ "Products | Rentals" ], "summary": "Create rental products of a given source product", "operationId": "RentalsCreateRentalProducts", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental products successfully created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRentalProductCreateResult" } } } } } } }, "/api/Rentals/GetRentalProductsBySource": { "post": { "tags": [ "Products | Rentals" ], "summary": "Get rental products by the id of the source product", "operationId": "RentalsGetRentalProductsBySource", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumGetRentalProductsBySourceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumGetRentalProductsBySourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumGetRentalProductsBySourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumGetRentalProductsBySourceRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental products found and returned", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" } } } } } } } }, "/api/Rentals/DeleteRentalProducts": { "delete": { "tags": [ "Products | Rentals" ], "summary": "Delete the given rental product(s). Optionally reclaim the inventory to a given warehouse", "operationId": "RentalsDeleteRentalProducts", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumDeleteRentalProductsRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumDeleteRentalProductsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumDeleteRentalProductsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumDeleteRentalProductsRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental products successfully deleted", "content": { "text/plain": { "schema": { "type": "integer", "format": "int64" } }, "application/json": { "schema": { "type": "integer", "format": "int64" } }, "text/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/api/Rentals/AddRentalProductToCart": { "post": { "tags": [ "Products | Rentals" ], "summary": "Add a rental product and deposit as line items in cart", "operationId": "RentalsAddRentalProductToCart", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumAddRentalProductToCartRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumAddRentalProductToCartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumAddRentalProductToCartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumAddRentalProductToCartRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental product and deposit successfully added to cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "422": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Rentals/AddRentalDepositToCart": { "post": { "tags": [ "Products | Rentals" ], "summary": "Add a deposit for a rental product as a line item in cart", "operationId": "RentalsAddRentalDepositToCart", "parameters": [ { "name": "cartId", "in": "query", "description": "Id of the cart to add the deposit line item to", "schema": { "type": "string", "description": "Id of the cart to add the deposit line item to", "nullable": true } }, { "name": "rentalProductSkuId", "in": "query", "description": "The SKU ID of the rental product to add the deposit for", "schema": { "type": "string", "description": "The SKU ID of the rental product to add the deposit for", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Rental deposit successfully added to cart", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Rentals/UpdateRentalProductDailyRate": { "post": { "tags": [ "Products | Rentals" ], "summary": "Update the daily rate price of a rental product", "operationId": "RentalsUpdateRentalProductDailyRate", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Daily rate price successfully updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "422": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Rentals/UpdateRentalProductDeposit": { "post": { "tags": [ "Products | Rentals" ], "summary": "Update the deposit price of a rental product", "operationId": "RentalsUpdateRentalProductDeposit", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateRentalProductPriceRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Deposit price successfully updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumProduct" }, "example": { "isSku": false, "parentId": "ABC", "variants": [ { "skuId": "000000000001", "isSku": true, "id": "000000000001", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "S", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000002", "isSku": true, "id": "000000000002", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "M", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 }, { "skuId": "000000000003", "isSku": true, "id": "000000000003", "ean": "1501031311309", "productId": "ABC-123", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "0001-01-01T00:00:00", "isActive": true, "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "size": "L", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } ], "id": "ABC-123_no", "productId": "ABC-123", "name": "Omnium Awesome sweater", "startDate": "0001-01-01T00:00:00", "endDate": "0001-01-01T00:00:00", "created": "2016-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "published": "2021-01-01T00:00:00", "isActive": true, "assets": [ { "assetId": "78901", "url": "https://omnium-cdn-url-goes-here.com/id/305/200/300", "externalUrl": "https://i.picsum.photos/id/305/200/300.jpg?hmac=qqxVDT5GPIxyVNSo9Y_9u_qZSwXU4Cy94gp7VAMVRIw", "isMainImage": true, "name": "Omnium Awesome Sweater main image", "description": "The awesome Omnium sweater.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "34567", "url": "https://omnium-cdn-url-goes-here.com/id/112/200/300", "externalUrl": "https://i.picsum.photos/id/112/200/300.jpg?hmac=2Y23MnaG65tK7HHRGB9XvjPcMETuBqK4fiu8t5rbBdg", "isMainImage": false, "name": "Back side Omnium Awesome Sweater", "description": "The sweater looks good from all sides, but this is just a random image though.", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 }, { "assetId": "12345", "url": "https://omnium-cdn-url-goes-here.com/id/544/200/300", "externalUrl": "https://i.picsum.photos/id/544/200/300.jpg?hmac=YL3M_fg_84Kqg0EQTvbltmjeGeQetARWPFA5YLn5hS0", "isMainImage": false, "name": "Close-up Omnium Awesome Sweater", "description": "Close-up on the sweater, but this is just a random image though.", "altText": "Close-up", "created": "0001-01-01T00:00:00", "modified": "0001-01-01T00:00:00", "length": 0 } ], "isBundle": false, "isKit": false, "isPackage": false, "isWriteProtected": false, "isInStock": false, "availableInventory": 0.0, "minQuantity": 0.0, "maxQuantity": 0.0, "weight": 900.0, "prices": [ { "marketId": "NOR", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 500.0, "currencyCode": "NOK", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "US", "validFrom": "0001-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 50.0, "currencyCode": "USD", "discountAmount": 0.0, "discountPercent": 0.0, "originalUnitPrice": 0.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false }, { "marketId": "NOR", "code": "000000000002", "validFrom": "2022-01-01T00:00:00", "validUntil": "2023-01-01T00:00:00", "minQuantity": 0.0, "unitPrice": 250.0, "currencyCode": "NOK", "customerGroup": "100", "discountAmount": 250.0, "discountPercent": 50.0, "originalUnitPrice": 500.0, "recommendedRetailPrice": 0.0, "isTaxExcluded": false, "cost": 47.0, "isBackorder": false, "isCustomerClubSpecificPrice": false } ], "properties": [ { "key": "CollarType", "value": "CrewNeck" } ], "language": "no", "color": "black", "brand": "Omnium Sweaters&Jeans", "shortDescription": "A black cotton sweater", "description": "A beautifully made sweater, with a stylish black color and with the well known Omnium logo in white large print. 100% cotton. Designed in Oslo.", "averageRating": 0.0, "ratingCount": 0, "isExcludedFromAnalytics": false, "unit": "pcs", "season": "FW22", "sortIndex": 0, "sortIndexBoost": 0, "sortIndexBase": 0, "isBackorder": false, "isPriceLocked": false, "isMainProductVariant": false, "isSerializableProduct": false, "isRental": false, "cost": 0.0 } } } }, "422": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Returns/Claims/ClaimTypes": { "get": { "tags": [ "Orders | Returns" ], "summary": "Get all available claim project types", "operationId": "ReturnsGetClaimTypes", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectType" } } } } }, "404": { "description": "Not Found" } } } }, "/api/Returns/{orderId}/UpdateStatus": { "post": { "tags": [ "Orders | Returns" ], "summary": "Update status on a return", "operationId": "ReturnsUpdateStatus", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "description": "The ID of the order", "nullable": true } } ], "requestBody": { "description": "The status which will be set on the return. New, InProgress, InTransit, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "500": { "description": "Server Error" } } } }, "/api/Returns/SearchReturnOrders": { "post": { "tags": [ "Orders | Returns" ], "summary": "Search returns", "operationId": "ReturnsSearchReturnOrders", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderViewModelOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderViewModelOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderViewModelOmniumSearchResult" } } } }, "404": { "description": "Not Found" } } } }, "/api/Returns/{orderId}/Return": { "post": { "tags": [ "Orders | Returns" ], "summary": "Create a return with all or some of the line items, with optional exchange order.", "description": "Sample request to create a return for a single order line:\r\n \r\n POST /api/returns/EPIC000001/return\r\n {\r\n \"returns\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"returnQuantity\": 1,\r\n \"returnReason\": \"Too small!\",\r\n \"returnType\": \"ProductWrongSize\",\r\n \"isStockUpdated\": true\r\n }\r\n ],\r\n \"storeId\": \"epic_webshop_no\",\r\n \"userId\": \"permagne@omnium.no\",\r\n \"creditPayment\": true,\r\n \"creditShipment\": true,\r\n \"chargeShipmentCost\": true,\r\n \"chargeShipmentCostAmount\": 10,\r\n \"handlingTotal\": 5,\r\n \"properties\": [\r\n { \"key\": \"CreateReturnLabel\", \"value\": \"true\" }\r\n ]\r\n }\r\n \r\nExample 1: Exchange with same value\r\nCustomer returns product A (100 NOK) and gets product B (also 100 NOK). In this case, the return was done in physical store, so we'll also update shippingMethodName to \"PickUpInStore\" and set the order type for the exchange order to POS\r\n \r\n {\r\n \"returns\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"returnQuantity\": 1,\r\n \"returnReason\": \"Too small!\",\r\n \"returnType\": \"ProductWrongSize\",\r\n \"isStockUpdated\": true\r\n }\r\n ],\r\n \"storeId\": \"epic_webshop_no\",\r\n \"userId\": \"permagne@omnium.no\",\r\n \"creditPayment\": true,\r\n \"omniumExchangeOrderOptions\": {\r\n \"exchangeOrderLines\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"076331601706\",\r\n \"placedPrice\": 100,\r\n \"quantity\": 1\r\n }\r\n ],\r\n \"orderType\": \"POS\",\r\n \"shippingMethodName\": \"PickUpInStore\"\r\n }\r\n }\r\n \r\nExample 2: Exchange with higher value\r\nCustomer returns product A (100 NOK) and buys product B (150 NOK)\r\n \r\n {\r\n \"returns\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"returnQuantity\": 1,\r\n \"returnReason\": \"Wrong product\",\r\n \"returnType\": \"ProductWrongItem\",\r\n \"isStockUpdated\": true\r\n }\r\n ],\r\n \"storeId\": \"epic_webshop_no\",\r\n \"userId\": \"permagne@omnium.no\",\r\n \"creditPayment\": true,\r\n \"omniumExchangeOrderOptions\": {\r\n \"exchangeOrderLines\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"076331601707\",\r\n \"placedPrice\": 150,\r\n \"quantity\": 1\r\n }\r\n ],\r\n \"additionalPayments\": [\r\n {\r\n \"amount\": 50,\r\n \"paymentMethodName\" : \"PaidInStore\",\r\n \"status\": \"Processed\",\r\n \"transactionId\": \"be5422f4-25d7-47fc-a664-61590266c7fa\",\r\n \"transactionType\": \"Sale\"\r\n }\r\n ]\r\n }\r\n }\r\n \r\nExample 3: Exchange with lower value\r\nCustomer returns product A (100 NOK) and gets product B (90 NOK)\r\n \r\n {\r\n \"returns\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"returnQuantity\": 1,\r\n \"returnReason\": \"Preferred another product\",\r\n \"returnType\": \"ChangedMind\",\r\n \"isStockUpdated\": true\r\n }\r\n ],\r\n \"storeId\": \"epic_webshop_no\",\r\n \"userId\": \"permagne@omnium.no\",\r\n \"creditPayment\": true,\r\n \"omniumExchangeOrderOptions\": {\r\n \"exchangeOrderLines\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"code\": \"076331601708\",\r\n \"placedPrice\": 90,\r\n \"quantity\": 1\r\n }\r\n ]\r\n }\r\n }", "operationId": "ReturnsReturn", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "description": "The ID of the order", "nullable": true } } ], "requestBody": { "description": "List of items to return. StoreId for return and userId", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnRequestModel" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } } } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "500": { "description": "Server Error" } } } }, "/api/Returns/CreateReplacementOrder": { "post": { "tags": [ "Orders | Returns" ], "summary": "Create a replacement order with all or some of the line items.", "description": "Sample request to create a replacement order for a single order line\r\n \r\n POST /api/returns/CreateReplacementOrder\r\n {\r\n \"orderId\": \"EPIC000001\",\r\n \"orderLineReplacements\": [\r\n {\r\n \"lineItemId\": \"1\",\r\n \"quantity\": 1,\r\n \"replacementType\": \"Damaged\",\r\n \"replacementReason\": \"Replacement for damaged goods\"\r\n \"skuId\": \"product sku if you want to replace current item with another product\"\r\n },\r\n ],\r\n \"comment\": \"Replacement for damaged goods\",\r\n \"amountToCredit\": \"399.00\",\r\n }", "operationId": "ReturnsCreateReplacementOrder", "requestBody": { "description": "Id of order, and order lines to replace.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumReplacementRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReplacementRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReplacementRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumReplacementRequestModel" } } }, "required": true }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } } } } }, "404": { "description": "Not Found" }, "400": { "description": "Bad Request" }, "500": { "description": "Server Error" } } } }, "/api/Returns/{orderId}/{returnId}": { "patch": { "tags": [ "Orders | Returns" ], "summary": "Patch Return - update only values in request", "operationId": "ReturnsPatchReturn", "parameters": [ { "name": "orderId", "in": "path", "description": "ID of existing order. (Required)", "required": true, "schema": { "type": "string", "description": "ID of existing order. (Required)", "nullable": true } }, { "name": "returnId", "in": "path", "description": "ID of return. (Required)", "required": true, "schema": { "type": "string", "description": "ID of return. (Required)", "nullable": true } } ], "requestBody": { "description": "Order patches. Properties with value will be updated", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderFormPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderFormPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderFormPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumReturnOrderFormPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Return updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" } } } }, "404": { "description": "Order is not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Return patch is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Role/{roleId}": { "get": { "tags": [ "Users" ], "summary": "Get role by ID", "operationId": "RoleGet", "parameters": [ { "name": "roleId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Delete a role", "operationId": "RoleDelete", "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Role/GetAll": { "get": { "tags": [ "Users" ], "summary": "Get all roles", "operationId": "RoleGetAll", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRole" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRole" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRole" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Role/Add": { "post": { "tags": [ "Users" ], "summary": "Add a new OmniumRole", "operationId": "RoleAdd", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Role/Update": { "put": { "tags": [ "Users" ], "summary": "Update a role", "operationId": "RoleUpdate", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumRole" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Settings/OrderSettings": { "get": { "tags": [ "Settings" ], "summary": "Returns order settings", "operationId": "SettingsOrderSettings", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderSettings" } } } } } } }, "/api/Settings/OrderTypes": { "get": { "tags": [ "Settings" ], "summary": "Returns order type settings", "operationId": "SettingsOrderTypes", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderType" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderType" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderType" } } } } } } } }, "/api/Settings/CustomerSettings": { "get": { "tags": [ "Settings" ], "summary": "Returns customer settings", "operationId": "SettingsCustomerSettings", "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCustomerSettings" } } } } } } }, "/api/ShipmentOptions/{marketId}/ShipmentOptions": { "get": { "tags": [ "Markets" ], "summary": "Get shipment options for the market.", "operationId": "ShipmentOptionsGetShipmentOptions", "parameters": [ { "name": "marketId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } } } }, "404": { "description": "Not Found" } } } }, "/api/ShipmentOptions/{marketId}/ShipmentOption": { "patch": { "tags": [ "Markets" ], "summary": "Patch the list of shipment options. If the patch object has same ShippingMethodId or ShippingMethodName, it modifies the shipping option. If not, id adds a new one.", "operationId": "ShipmentOptionsPatchShipmentOption", "parameters": [ { "name": "marketId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumShipmentOption" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumShipmentOption" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumShipmentOption" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumShipmentOption" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Markets" ], "summary": "Patch the list of shipment options.", "operationId": "ShipmentOptionsDeleteShipmentOption", "parameters": [ { "name": "marketId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "" } }, { "name": "shippingMethodId", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "shippingMethodName", "in": "query", "description": "", "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" } } } } }, "404": { "description": "Not Found" } } } }, "/api/OrderShipments/{orderId}": { "put": { "tags": [ "Orders | Shipments" ], "summary": "Put shipment on order", "description": "Add/Update shipment on order.", "operationId": "ShipmentsPut", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "string", "description": "Order ID", "nullable": true } } ], "requestBody": { "description": "Shipment to put", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "Shipment to put", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "Shipment to put", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "Shipment to put", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "Shipment to put", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Orders | Shipments" ], "summary": "Patch Shipment on order", "description": "Patch shipment on order.", "operationId": "ShipmentsPatch", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "string", "description": "Order ID", "nullable": true } } ], "requestBody": { "description": "Shipment to put", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "Shipment to put", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "Shipment to put", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "Shipment to put", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "Shipment to put", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrder" }, "example": { "orderNumber": "102848", "customerId": "4741044683", "customerNumber": "4741044683", "billingCurrency": "NOK", "customerName": "Ola Nordmann", "customerPhone": "4741044683", "customerEmail": "ola.nordmann.omnium@gmail.com", "marketId": "NOR", "billingAddress": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "email": "ola.nordmann.omnium@gmail.com" }, "orderForm": { "shipments": [ { "discounts": [ { "discountType": "Shipping", "skuIds": [], "discountAmount": 0.0, "maxDiscountAmount": 0.0, "discountCode": "FreeShipping", "discountName": "Gratis frakt over 1000 kr", "discountValue": 100.0, "rewardType": "Percentage", "priority": 10, "canBeCombinedWithOtherPromotions": false, "alwaysApply": false, "isBonusPointsReward": false } ], "shipmentId": "1", "shippingMethodName": "Bring_SERVICEPAKKE", "shippingTax": 0.0, "shipmentTaxRate": 25.0, "shippingDiscountAmount": 0.0, "shippingSubTotal": 0.0, "shippingTotal": 0.0, "shippingSubTotalExclTax": 29215.36, "shippingCreditedTotal": 0.0, "status": "AwaitingInventory", "subTotal": 36519.2, "total": 36519.2, "taxTotal": 7303.84, "warehouseCode": "WebShop", "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "properties": [], "address": { "firstName": "Ola", "lastName": "Nordmann", "line1": "Hoffsveien 1a", "streetNumber": "1a", "apartmentNumber": "0402", "city": "Oslo", "countryCode": "NO", "postalCode": "0275", "daytimePhoneNumber": "+4741044683", "eveningPhoneNumber": "", "email": "ola.nordmann.omnium@gmail.com" }, "transit": false, "expectedDeliveryDate": "0001-01-01T00:00:00", "packages": [], "isAllocated": false } ], "lineItems": [ { "lineItemId": "89c50254-e68e-4482-a498-cc0b3396df35", "code": "c-56235-58", "displayName": "Cannondale Synapse Carbon disc", "placedPrice": 38900.0, "placedPriceExclTax": 31120.0, "extendedPrice": 34990.93, "extendedPriceExclTax": 27992.74, "discountedPrice": 38900.0, "discountedPriceExclTax": 31120.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 3909.07, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 28900.0, "costTotal": 28900.0, "discounted": 0.0, "discountedExclTax": 31120.0, "taxTotal": 6998.19, "taxRate": 25.0, "properties": [], "size": "58", "color": "Deep blue", "productId": "c-56235", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "7ba2282a-ca37-4819-b3eb-090862cd836c", "code": "cb-9988", "displayName": "CamelBak Podium Chill Bottle 710ml - White", "placedPrice": 199.0, "placedPriceExclTax": 159.2, "extendedPrice": 0.0, "extendedPriceExclTax": 0.0, "discountedPrice": 0.0, "discountedPriceExclTax": 0.0, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 0.0, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": true, "isReadOnlyByCustomer": false, "cost": 29.0, "costTotal": 29.0, "discounted": 199.0, "discountedExclTax": 0.0, "taxTotal": 0.0, "taxRate": 25.0, "properties": [], "size": "", "color": "White", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false }, { "lineItemId": "47f644b9-3c22-44c9-9089-a21d888aea95", "code": "castelli-33221-S", "displayName": "Castelli Gabba 3", "placedPrice": 1699.0, "placedPriceExclTax": 1359.2, "extendedPrice": 1528.27, "extendedPriceExclTax": 1222.62, "discountedPrice": 1699.0, "discountedPriceExclTax": 1359.2, "lineItemDiscountAmount": 0.0, "lineItemDiscountAmountExclTax": 0.0, "suggestedRetailPrice": 0.0, "suggestedRetailPriceExclTax": 0.0, "orderDiscountAmount": 170.73, "creditedAmount": 0.0, "quantity": 1.0, "returnQuantity": 0.0, "canceledQuantity": 0.0, "deliveredQuantity": 0.0, "isGift": false, "isBackorder": false, "isReadOnly": false, "isReadOnlyByCustomer": false, "cost": 649.0, "costTotal": 649.0, "discounted": 0.0, "discountedExclTax": 1359.2, "taxTotal": 305.65, "taxRate": 25.0, "properties": [], "size": "S", "color": "", "productId": "castelli-33221", "orderLineDiscounts": [], "isRental": false, "updateStock": false, "isPackage": false, "isBundle": false, "isPackageProduct": false, "isPackageBrokeDown": false, "isVirtualProduct": false, "isConfigurableProduct": false, "reservedInventoryQuantity": 0.0, "reservedInventory": false } ], "discounts": [ { "discountType": "Order", "skuIds": [], "discountAmount": 4079.8, "maxDiscountAmount": 0.0, "discountName": "God kunde", "discountValue": 10.0, "rewardType": "Percentage", "priority": 1, "canBeCombinedWithOtherPromotions": true, "alwaysApply": true, "isBonusPointsReward": false } ], "payments": [ { "amount": 36519.2, "paymentId": 0, "paymentMethodId": "00000000-0000-0000-0000-000000000000", "paymentMethodName": "KlarnaCheckout", "status": "Processed", "transactionId": "38a53650-9cb8-6f85-a4fe-617edb3fbb24", "transactionType": "Authorization", "properties": [], "isManuallyAdded": false } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "shippingSubTotalExclTax": 0.0, "shippingCreditedTotal": 0.0, "cartName": "Tilbud på landevei", "cartId": "C100197", "couponCodes": [], "shippingTotal": 0.0, "handlingTotal": 0.0, "orderLevelTax": 0.0, "taxTotal": 7303.84, "discountAmount": 4079.8, "subTotal": 36519.2, "subTotalExclTax": 0.0, "total": 36519.2, "totalExclTax": 29215.36, "authorizedPaymentTotal": 0.0, "capturedPaymentTotal": 0.0, "creditPaymentTotal": 0.0, "properties": [], "fullRefund": false }, "publicOrderNotes": [ { "created": "2020-06-03T08:52:05", "detail": "Flott! Ser på det med en gang! Hilsen Ola", "creator": "Ola Nordmann", "attachments": [] }, { "created": "2020-06-03T08:51:02", "detail": "Tilbudet er nå tilgjengelig", "title": "Ordrenummer C100197", "creator": "Eivind Lærum", "attachments": [] } ], "shippingDiscountTotal": 0.0, "shippingSubTotal": 0.0, "status": "New", "remainingPayment": 0.0, "salesPersonId": "eivind@omnium.no", "modified": "2020-06-03T08:55:31", "created": "2020-06-03T08:55:31", "properties": [], "orderType": "Online", "storeId": "WebShop", "returnOrderForms": [], "lineItemsCost": 0.0, "netTotal": 0.0, "netTotalExclTax": 0.0, "contactPerson": { "firstName": "John", "lastName": "Doe", "phone": "+1 804-222-1111", "email": "john.doe@gmail.com", "address": { "city": "Oslo", "countryCode": "NO", "email": "john.doe@gmail.com", "phone": "+1 804-222-1111" }, "roles": [ "CEO" ], "role": "CEO", "notify": false, "isPrimaryContact": true, "privateCustomerId": "18042221111" }, "externalIds": [], "isReadOnly": false, "isNotificationsDisabled": false, "subTotal": 0.0, "subTotalExclTax": 0.0, "taxTotal": 0.0, "total": 0.0, "totalExclTax": 0.0, "discountTotalIncVat": 0.0, "isAnonymized": false, "isReallocated": false } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/OrderShipments/{orderId}/DeleteShipments": { "delete": { "tags": [ "Orders | Shipments" ], "summary": "Delete shipment", "description": "Delete shipment from order.", "operationId": "ShipmentsDeleteShipments", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "string", "description": "Order ID" } } ], "requestBody": { "description": "Shipment IDs to delete", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Shipment IDs to delete", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/OrderShipments/{orderId}/AddOrderLinesToShipment": { "put": { "tags": [ "Orders | Shipments" ], "summary": "Add order lines to shipment", "description": "Add existing order lines to shipment.", "operationId": "ShipmentsAddOrderLinesToShipment", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "string", "description": "Order ID" } } ], "requestBody": { "description": "Shipment with lineItemIds to add", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentLineItemsUpdateModel" }, "description": "Shipment with lineItemIds to add", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentLineItemsUpdateModel" }, "description": "Shipment with lineItemIds to add", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentLineItemsUpdateModel" }, "description": "Shipment with lineItemIds to add", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentLineItemsUpdateModel" }, "description": "Shipment with lineItemIds to add", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Stores/{storeId}": { "get": { "tags": [ "Stores" ], "summary": "Returns a single store", "operationId": "StoresGet", "parameters": [ { "name": "storeId", "in": "path", "description": "ID of the store to return", "required": true, "schema": { "type": "string", "description": "ID of the store to return", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "400": { "description": "Store ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Store does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Stores/GetByExternalId": { "get": { "tags": [ "Stores" ], "summary": "Returns a list of stores", "operationId": "StoresGetByExternalId", "parameters": [ { "name": "id", "in": "query", "description": "External ID of the store to return", "schema": { "type": "string", "description": "External ID of the store to return", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store(s) with external ID found and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } } } }, "400": { "description": "Store external ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Store does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Stores": { "post": { "tags": [ "Stores" ], "summary": "Add a store to the OMS", "operationId": "StoresPost", "requestBody": { "description": "Store object that is added to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Store is added" }, "400": { "description": "Store ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Stores" ], "summary": "Create or update store in Omnium, overriding existing store", "operationId": "StoresPut", "requestBody": { "description": "Store object that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store is updated" }, "400": { "description": "Store ID is invalid" } } }, "get": { "tags": [ "Stores" ], "summary": "Get all stores", "operationId": "GetAllStores", "parameters": [ { "name": "filterPublicVisible", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Returning all stores", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumSearchResult" } } } }, "404": { "description": "No stores found" } } }, "delete": { "tags": [ "Stores" ], "summary": "Deletes a single store from the OMS", "operationId": "DeleteStoreByObject", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store deleted" }, "400": { "description": "Store is invalid" }, "404": { "description": "Store not found" } } } }, "/api/Stores/PatchStore": { "patch": { "tags": [ "Stores" ], "summary": "Patch store - update only some values in request", "operationId": "StoresPatchStore", "requestBody": { "description": "Store patch. Properties with value will be updated.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStorePatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStorePatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStorePatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStorePatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store updated successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStoreUpdateResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreUpdateResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreUpdateResult" } } } }, "400": { "description": "Store patch are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Stores/Update": { "post": { "tags": [ "Stores" ], "summary": "Update existing store, replacing all properties", "operationId": "StoresUpdate", "requestBody": { "description": "The store object to be updated in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store is updated, and returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "404": { "description": "Store does not exist", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Store ID is invalid" } } } }, "/api/Stores/Enrich": { "post": { "tags": [ "Stores" ], "summary": "Adding or enrich an existing store to the OMS", "operationId": "StoresEnrich", "requestBody": { "description": "Store object that needs to be enriched in the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStore" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store is updated" }, "201": { "description": "Store is created" }, "400": { "description": "Store ID is invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Stores/AddMany": { "post": { "tags": [ "Stores" ], "summary": "Adds a range of stores to the OMS.", "operationId": "StoresAddMany", "requestBody": { "description": "A list of Store objects that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "A list of Store objects that needs to be added to the OMS", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "A list of Store objects that needs to be added to the OMS", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "A list of Store objects that needs to be added to the OMS", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "A list of Store objects that needs to be added to the OMS", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Stores are added" }, "400": { "description": "Stores in request are invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Stores/SearchStores": { "post": { "tags": [ "Stores" ], "summary": "Search stores and warehouses", "operationId": "StoresSearchStores", "requestBody": { "description": "The OmniumStoreSearchRequest contains properties for filtering stores and warehouses", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumStoreSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumStoreSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Search successful, returning stores", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumStoreOmniumResult" } } } }, "400": { "description": "Search request invalid", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Stores/{id}": { "delete": { "tags": [ "Stores" ], "summary": "Deletes a single store from the OMS", "operationId": "StoresDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Store deleted" }, "400": { "description": "Store ID is invalid" }, "404": { "description": "Store not found" } } } }, "/api/Subscriptions": { "put": { "tags": [ "Orders | Subscriptions" ], "summary": "Add or update subscription", "operationId": "SubscriptionsPut", "requestBody": { "description": "Subscriptions object that needs to be added to the OMS", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } } } }, "post": { "tags": [ "Orders | Subscriptions" ], "summary": "Create a new subscription, with an auto generated ID", "operationId": "SubscriptionsPost", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Subscriptions/Update": { "post": { "tags": [ "Orders | Subscriptions" ], "summary": "Update subscription", "operationId": "SubscriptionsUpdate", "parameters": [ { "name": "runWorkflow", "in": "query", "description": "If true, workflow will be processed", "schema": { "type": "boolean", "description": "If true, workflow will be processed" } } ], "requestBody": { "description": "Subscription to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Subscriptions/{id}": { "get": { "tags": [ "Orders | Subscriptions" ], "summary": "Returns a single subscription", "operationId": "SubscriptionsGet", "parameters": [ { "name": "id", "in": "path", "description": "ID of the subscription to return", "required": true, "schema": { "type": "string", "description": "ID of the subscription to return" } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "404": { "description": "The subscription was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Orders | Subscriptions" ], "summary": "Deletes a subscription from the OMS", "operationId": "SubscriptionsDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Subscription to delete was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Subscriptions/Search": { "post": { "tags": [ "Orders | Subscriptions" ], "summary": "Search and filtering of subscriptions.", "operationId": "SubscriptionsSearch", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscriptionOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Subscriptions/CreatePendingOrders/{numberOfPendingOrders}": { "post": { "tags": [ "Orders | Subscriptions" ], "summary": "Create pending orders for subscription", "operationId": "SubscriptionsCreatePendingOrders", "parameters": [ { "name": "numberOfPendingOrders", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSubscription" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Subscriptions/{id}/CancelSubscription": { "post": { "tags": [ "Orders | Subscriptions" ], "summary": "Cancel a subscription and all its pending orders", "operationId": "SubscriptionsCancelSubscription", "parameters": [ { "name": "id", "in": "path", "description": "ID of the subscription", "required": true, "schema": { "type": "string", "description": "ID of the subscription", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Subscription was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers/{supplierId}": { "get": { "tags": [ "Suppliers" ], "summary": "Get supplier", "operationId": "SuppliersGetSupplier", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers/{supplierId}/{versionId}": { "get": { "tags": [ "Suppliers" ], "summary": "Get supplier version", "operationId": "SuppliersGetSupplierVersion", "parameters": [ { "name": "supplierId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers/Search": { "post": { "tags": [ "Suppliers" ], "summary": "Search suppliers", "description": "Search suppliers", "operationId": "SuppliersSearch", "requestBody": { "description": "Search request object for suppliers", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSupplierOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplierOmniumSearchResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers": { "put": { "tags": [ "Suppliers" ], "summary": "Update supplier", "description": "Update supplier", "operationId": "SuppliersUpdate", "requestBody": { "description": "Supplier", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumSupplier" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers/UpdateMany": { "put": { "tags": [ "Suppliers" ], "summary": "Update many suppliers", "description": "Update many suppliers", "operationId": "SuppliersUpdateMany", "requestBody": { "description": "Suppliers", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSupplier" }, "description": "Suppliers", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSupplier" }, "description": "Suppliers", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSupplier" }, "description": "Suppliers", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSupplier" }, "description": "Suppliers", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Suppliers/{id}": { "delete": { "tags": [ "Suppliers" ], "summary": "Delete supplier", "operationId": "SuppliersDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Supplier deleted" }, "404": { "description": "Supplier not found" }, "400": { "description": "Invalid request" } } } }, "/api/Projects/{projectId}/TimeEntries": { "get": { "tags": [ "Projects | Time entries" ], "summary": "Get all project types", "operationId": "TimeEntriesGetTimeEntriesForProject", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/TimeEntries/Search": { "post": { "tags": [ "Projects | Time entries" ], "summary": "Find time entries", "description": "Search time entries.", "operationId": "TimeEntriesSearch", "requestBody": { "description": "Search request object for finding time entries", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntrySearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntrySearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntrySearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntrySearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTimeEntry" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/TimeEntries/Add": { "put": { "tags": [ "Projects | Time entries" ], "summary": "Create time entry", "description": "Add/update a time entry.", "operationId": "TimeEntriesAdd", "requestBody": { "description": "Omnium TimeEntry object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumTimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Projects/TimeEntries/{id}": { "delete": { "tags": [ "Projects | Time entries" ], "summary": "Delete time entries", "operationId": "TimeEntriesDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Time entry deleted" }, "404": { "description": "Not found" }, "400": { "description": "Bad request" } } } }, "/api/Projects/TimeEntries/DeleteMany": { "post": { "tags": [ "Projects | Time entries" ], "summary": "Delete time entries", "operationId": "TimeEntriesDeleteMany", "requestBody": { "description": "Ids of objects to delete", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of objects to delete", "nullable": true } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of objects to delete", "nullable": true } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of objects to delete", "nullable": true } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "Ids of objects to delete", "nullable": true } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Time entries deleted" }, "400": { "description": "Bad request" } } } }, "/api/Token": { "post": { "tags": [ "Tokens" ], "summary": "Create a new token", "operationId": "TokenPost", "parameters": [ { "name": "clientId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "clientSecret", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "returnAsJson", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumTokenResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumTokenResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumTokenResponse" } } } } } } }, "/api/Trigger": { "post": { "tags": [ "Triggers" ], "summary": "Trigger a preconfigured action", "operationId": "TriggersPost", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumTriggerRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumTriggerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumTriggerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumTriggerRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Action triggered successfully", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Trigger was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/User/Add": { "post": { "tags": [ "Users" ], "summary": "Add a new omnium user. ID must be a valid email-address and not be in use by another user.", "operationId": "UserAdd", "requestBody": { "description": "The user object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/User": { "put": { "tags": [ "Users" ], "summary": "Add or save a user. ID must be a valid email-address.", "operationId": "UserPut", "requestBody": { "description": "The user object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/User/{id}": { "get": { "tags": [ "Users" ], "summary": "Get an omnium user.", "operationId": "UserGet", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUserModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "patch": { "tags": [ "Users" ], "summary": "Patch user - update only values in request", "operationId": "UserPatchUser", "parameters": [ { "name": "id", "in": "path", "description": "User ID to patch", "required": true, "schema": { "type": "string", "description": "User ID to patch", "nullable": true } } ], "requestBody": { "description": "Patch request", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUserPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUserPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUserPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUserPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "User updated successfully" }, "400": { "description": "Invalid userId", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Deletes a single user from the OMS", "operationId": "UserDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/User/GetAll": { "get": { "tags": [ "Users" ], "summary": "Get all users", "description": "Valid sort orders: UserAscending, UserDescending, CreatedAscending, CreatedDescending, LastLoginAscending, LastLoginDescending, FirstnameLastnameEmail", "operationId": "UserGetAll", "parameters": [ { "name": "sortOrder", "in": "query", "description": "Sort order (optional)", "schema": { "type": "string", "description": "Sort order (optional)", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumUserModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumUserModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumUserModel" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Vouchers": { "put": { "tags": [ "Vouchers" ], "summary": "Add or save a voucher. If ID is null, it will be created.", "operationId": "VouchersPut", "requestBody": { "description": "The voucher object", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucher" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucher" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucher" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucher" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "201": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Vouchers/{id}": { "delete": { "tags": [ "Vouchers" ], "summary": "Deletes a single voucher from the OMS", "operationId": "VouchersDelete", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "204": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Vouchers/Search": { "post": { "tags": [ "Vouchers" ], "summary": "Search for vouchers", "operationId": "VouchersSearchVouchers", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Vouchers/ScrollSearch": { "post": { "tags": [ "Vouchers" ], "summary": "Scroll large amounts of vouchers", "description": "The scroll Id obtained here should be passed to the scroll endpoint to continue the scroll operation (fetch the next page of results). Page/take not relevant default is 5000 vouchers in each batch.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "VouchersScrollSearchVouchers", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherSearchRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumSearchResult" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Vouchers/Scroll/{id}": { "get": { "tags": [ "Vouchers" ], "summary": "Scroll vouchers is used to get a large amount of vouchers.", "description": "The scroll Id can be obtained from a standard search request that supports scrolling.\r\n Scrolling is not intended for real time user requests, but rather for processing large amounts of data.", "operationId": "VouchersScroll", "parameters": [ { "name": "id", "in": "path", "description": "The scroll id is passed on the request the next batch of data from the original request.", "required": true, "schema": { "type": "string", "description": "The scroll id is passed on the request the next batch of data from the original request.", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumVoucherOmniumResult" } } } } } } }, "/api/Orders/{orderId}/UpdateStatus": { "post": { "tags": [ "Orders | Workflow" ], "summary": "Update status and run workflow for an order or shipment", "description": "If you need to update status on a shipment and not the order, set the corresponding \"shipmentId\" on the \"shipmentInfo\" object. The shipmentInfo object also allows you to update shipment information, such as tracking link or shipping method.\r\n
\r\nIf you do not wish to automatically run the workflow for the order or shipment, you can specify this using \"skipRunWorkflow:true\".\r\n
\r\nSet \"executeWorkFlowAsync:true\" to process the status update and workflow asynchronously via a Service Bus queue. The API returns 202 Accepted immediately without waiting for the workflow to complete. Ignored when \"skipRunWorkflow:true\".\r\n

\r\nBasic example on how you would update status to \"InProgress\" for an existing order:\r\n \r\n POST /api/orders/{orderId}/UpdateStatus\r\n {\r\n \"status\": \"InProgress\"\r\n }\r\n \r\nExample on how you would set status for an existing shipment (with shipmentId \"1\") to \"Completed\" and run workflow for the shipment while also updating tracking url:\r\n \r\n POST /api/orders/{orderId}/UpdateStatus\r\n {\r\n \"status\": \"Completed\",\r\n \"shipmentInfo\": { \r\n \"shipmentId\": \"1\",\r\n \"trackingUrl\" : \"https://omnium.no/not-an-actual-tracking-link\"\r\n }\r\n }", "operationId": "WorkflowUpdateStatus", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "description": "The ID of the order", "nullable": true } } ], "requestBody": { "description": "The status which will be set on the order. New, InProgress, InTransit, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateStatusPatch" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "202": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Order to update was not found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Orders/{orderId}/OrderLinesUpdate": { "post": { "tags": [ "Orders | Workflow" ], "summary": "Create or update shipments and order lines, and run workflow.", "description": "If no shipmentId is set, the first (and possible only) shipment is used. If a non-existing shipment ID is specific, a new shipment will be created.
\r\nIf you target an existing shipment, by specifying shipmentId, you could also update shipment tracking link/number and shippingMethodName.\r\nIf you create a new partial shipment and do not specify shipping information, shipping information will be copied from the previous existing shipment.
\r\nCombination of deliveredQuantity and splitQuantity should not be used. SplitQuantity will then be ignored.\r\n

Asynchronous processing (recommended): Set {enqueue: true} to process the update asynchronously via a Service Bus queue.\r\nThe API returns {202 Accepted} immediately without waiting for the workflow to complete.\r\nWhen omitted or set to {false}, the update is processed synchronously and returns {200 OK} with the workflow result.\r\n

\r\nExample on how you create a partial delivered shipment (with shipmentId \"2\" - this could be set to any string) containing order lines with lineItemId \"4\" and \"6\", to \"Completed\" and run workflow for the shipment:\r\n \r\n POST /api/orders/1234/OrderLinesUpdate\r\n {\r\n \"status\": \"Completed\",\r\n \"enqueue\": true,\r\n \"lineItemUpdates\": [\r\n {\r\n \"lineItemId\": \"4\",\r\n \"deliveredQuantity\": 4\r\n },\r\n {\r\n \"lineItemId\": \"6\",\r\n \"deliveredQuantity\": 6\r\n }\r\n ],\r\n \"shipmentInfo\": {\r\n \"shipmentId\": \"2\",\r\n \"shippingMethodName\": \"Bring\"\r\n }\r\n }\r\n \r\n \r\n
\r\n Example on how you create a partial shipment without delivered items(using splitQuantity, with shipmentId \"2\" - this could be set to any string) containing order lines with lineItemId \"4\" and \"6\", to \"InProgress\" and run workflow for the shipment.\r\n If the new partial shipment should be sent from a different warehouse that original shipment, set shipmentInfo.warehouseCode.\r\n You can also specify pickup point information if the partial shipment should be delivered to a different pickup point:\r\n \r\n POST /api/orders/1234/OrderLinesUpdate\r\n {\r\n \"status\": \"InProgress\",\r\n \"enqueue\": true,\r\n \"lineItemUpdates\": [\r\n {\r\n \"lineItemId\": \"4\",\r\n \"splitQuantity\": 2\r\n },\r\n {\r\n \"lineItemId\": \"6\",\r\n \"splitQuantity\": 1\r\n }\r\n ],\r\n \"shipmentInfo\": {\r\n \"shipmentId\": \"2\",\r\n \"shippingMethodName\": \"Bring\",\r\n \"warehouseCode\": \"warehouse4\",\r\n \"servicePointId\": \"12345\",\r\n \"pickUpPointInformation\": {\r\n \"servicePointId\": \"12345\",\r\n \"name\": \"Pickup Point Name\",\r\n \"address\": {\r\n \"street\": \"Main Street 1\",\r\n \"postalCode\": \"12345\",\r\n \"city\": \"City Name\",\r\n \"country\": \"Norway\",\r\n \"countryCode\": \"NO\"\r\n }\r\n }\r\n }\r\n }\r\n \r\n \r\n
\r\nExample on how you would set status for an existing shipment (with shipmentId \"1\") to \"Completed\", while setting delivered quantity and cancelled quantity:\r\n \r\n POST /api/orders/1234/OrderLinesUpdate\r\n {\r\n \"status\": \"Completed\",\r\n \"enqueue\": true,\r\n \"lineItemUpdates\": [\r\n {\r\n \"lineItemId\": \"4\",\r\n \"deliveredQuantity\": 4\r\n },\r\n {\r\n \"lineItemId\": \"5\",\r\n \"deliveredQuantity\": 2,\r\n \"canceledQuantity\": 3\r\n },\r\n {\r\n \"lineItemId\": \"6\",\r\n \"canceledQuantity\": 6\r\n }\r\n ],\r\n \"shipmentInfo\": {\r\n \"shipmentId\": \"1\"\r\n }\r\n }\r\n \r\n
\r\n \r\n \r\nExample on how you would split a single order line (that has more than 1 quantity), creating a partial delivery (a new shipment) which will be set to \"Completed\"\r\n \r\n POST /api/orders/1234/OrderLinesUpdate\r\n {\r\n \"status\": \"Completed\",\r\n \"enqueue\": true,\r\n \"lineItemUpdates\": [\r\n {\r\n \"lineItemId\": \"4\",\r\n \"splitQuantity\": 1\r\n }\r\n ],\r\n \"shipmentInfo\": {\r\n \"orderStatus\": \"Completed\",\r\n }\r\n }", "operationId": "WorkflowPartialUpdate", "parameters": [ { "name": "orderId", "in": "path", "description": "The ID of the order", "required": true, "schema": { "type": "string", "description": "The ID of the order", "nullable": true } } ], "requestBody": { "description": "Line items to update and The status which will be set on the order. New, InProgress, InTransit, ReadyForPickup, Completed, OrderCanceled, PartiallyShipped", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateLineItemStatusPatch" }, "example": { "status": "Completed", "shipmentInfo": { "shipmentMethodName": "Bring", "trackingUrl": "https://someshippingprovider.com/123", "shipmentId": "2" }, "isShippingCostKeptForExistingShipment": false } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateLineItemStatusPatch" }, "example": { "status": "Completed", "shipmentInfo": { "shipmentMethodName": "Bring", "trackingUrl": "https://someshippingprovider.com/123", "shipmentId": "2" }, "isShippingCostKeptForExistingShipment": false } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateLineItemStatusPatch" }, "example": { "status": "Completed", "shipmentInfo": { "shipmentMethodName": "Bring", "trackingUrl": "https://someshippingprovider.com/123", "shipmentId": "2" }, "isShippingCostKeptForExistingShipment": false } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumUpdateLineItemStatusPatch" }, "example": { "status": "Completed", "shipmentInfo": { "shipmentMethodName": "Bring", "trackingUrl": "https://someshippingprovider.com/123", "shipmentId": "2" }, "isShippingCostKeptForExistingShipment": false } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "202": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/Orders/{cartId}/processCartWorkflowTest/{status}": { "post": { "tags": [ "Orders | Workflow" ], "summary": "Process cart workflow test (Dry run of workflow, no changes to order or shipment will be made)", "operationId": "WorkflowProcessCartWorkflowTest", "parameters": [ { "name": "cartId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } }, { "name": "status", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/Orders/processExternalCartWorkflowTest/{status}": { "post": { "tags": [ "Orders | Workflow" ], "summary": "Process cart workflow test from a posted cart or order (Dry run of workflow).", "operationId": "WorkflowProcessExternalCartWorkflowTest", "parameters": [ { "name": "status", "in": "path", "description": "", "required": true, "schema": { "type": "string", "description": "", "nullable": true } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumCart" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumOrderWorkflowExecutionResult" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ZReport/GetOmniumZReports": { "post": { "tags": [ "POS | Reports" ], "summary": "Endpoint for fetching z reports. Reports are fetched from POS connectors if any IZReportFetcher\r\nconnectors are configured for the tenant.", "description": "ToDate will default to DateTime.now and fromDate will default to DateTime.Now.AddDays(-10);\r\n \r\nWhen StoreGroupIds are provided they are expanded to the stores in those groups and merged\r\nwith any explicitly listed StoreIds before fetching.\r\n \r\nExample to fetch the last 10 days of z-reports:\r\n{\r\n \"fromDate\": null,\r\n \"toDate\": null,\r\n \"marketIds\": null,\r\n \"storeIds\": null,\r\n \"storeGroupIds\": null\r\n}", "operationId": "ZReportGetOmniumZReports", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OmniumZReportFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OmniumZReportFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OmniumZReportFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OmniumZReportFilter" } } } }, "responses": { "429": { "description": "Client Error", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumZReport" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumZReport" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumZReport" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/api/ZReport/GenerateSAFTReport": { "post": { "tags": [ "POS | Reports" ], "operationId": "ZReportGenerateSAFTReport", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenerateSAFTReportRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSAFTReportRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateSAFTReportRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateSAFTReportRequest" } } } }, "responses": { "429": { "description": "Client Error", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } }, "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/xml": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } } } } } } } }, "components": { "schemas": { "OmniumAccountCategory": { "enum": [ "Sales", "OutputVat", "PaymentMethod", "Shipping", "Discount", "Rounding", "RefundPaymentMethod", "InternalTransferOut", "InternalTransferIn", "Receivable", "GiftCardLiability", "PaymentProviderFee", "Other", "CashFloat", "CashInTransit", "OverShort", "Tip", "DepositLiability" ], "type": "string", "description": "Category classifying what kind of accounting entry a ledger line represents." }, "OmniumAccountingLedgerLine": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ledger line ID. Set by Omnium.", "nullable": true }, "postingId": { "type": "string", "description": "ID of the parent posting this line belongs to.", "nullable": true }, "lineSequence": { "type": "integer", "description": "Order within the parent posting. Stable; used for sorting and hash determinism.", "format": "int32" }, "postingDate": { "type": "string", "description": "Accounting period date, denormalised from the parent posting.", "format": "date-time", "nullable": true }, "registerId": { "type": "string", "description": "Register that produced this line, when applicable (POS).", "nullable": true }, "storeId": { "type": "string", "description": "Store this line is booked to.", "nullable": true }, "accountingCompanyCode": { "type": "string", "description": "Accounting company code (when configured per store/market).", "nullable": true }, "accountNumber": { "type": "string", "description": "Account number this entry is booked to.", "nullable": true }, "accountName": { "type": "string", "description": "Human-readable account name.", "nullable": true }, "category": { "$ref": "#/components/schemas/OmniumAccountCategory" }, "debit": { "type": "number", "description": "Debit amount in posting currency.", "format": "decimal" }, "credit": { "type": "number", "description": "Credit amount in posting currency.", "format": "decimal" }, "currencyCode": { "type": "string", "description": "ISO currency code for the amount (e.g. NOK, SEK, EUR).", "nullable": true }, "vatCode": { "type": "string", "description": "VAT code (when applicable, on VAT-related lines).", "nullable": true }, "vatRate": { "type": "number", "description": "VAT rate as a percentage (e.g. 25 for 25%).", "format": "decimal", "nullable": true }, "vatAmount": { "type": "number", "description": "VAT amount in posting currency.", "format": "decimal", "nullable": true }, "taxGroupCode": { "type": "string", "description": "Tax-group code (from line-level snapshot).", "nullable": true }, "description": { "type": "string", "description": "Free-text description for the line.", "nullable": true }, "customerNumber": { "type": "string", "description": "Customer number (when applicable, e.g. for receivables).", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Invoice number (when applicable).", "nullable": true }, "creditNoteNumber": { "type": "string", "description": "Credit note number (when applicable).", "nullable": true }, "invoiceDate": { "type": "string", "description": "Invoice date (when applicable).", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "Due date (when applicable).", "format": "date-time", "nullable": true }, "kidNumber": { "type": "string", "description": "KID / payment-reference number (when applicable).", "nullable": true }, "dimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form dimensions / cost centres carried on the line.", "nullable": true } }, "additionalProperties": false, "description": "A single line on an accounting posting (one debit/credit entry for one account)." }, "OmniumAccountingLedgerLineOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAccountingLedgerLine" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumAccountingLedgerLineSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to return per page. Maximum 1000.", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take]).", "format": "int32" }, "postingId": { "type": "string", "description": "Filter to lines belonging to a specific posting.", "nullable": true }, "postingDateFrom": { "type": "string", "description": "Filter lines whose posting date is on or after this date (inclusive).", "format": "date-time", "nullable": true }, "postingDateTo": { "type": "string", "description": "Filter lines whose posting date is on or before this date (inclusive).", "format": "date-time", "nullable": true }, "storeId": { "type": "string", "description": "Filter by store ID. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingLedgerLineSearchRequest.StoreGroupId.", "nullable": true }, "storeGroupId": { "type": "string", "description": "Filter to lines from any store in the given store group. The API resolves this\r\nto the set of store IDs that belong to the group. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingLedgerLineSearchRequest.StoreId.", "nullable": true }, "registerId": { "type": "string", "description": "Filter by register ID.", "nullable": true }, "accountNumber": { "type": "string", "description": "Single account number; takes precedence over AccountNumbers if both are set.", "nullable": true }, "accountNumbers": { "type": "array", "items": { "type": "string" }, "description": "Filter to lines on any of the given account numbers.", "nullable": true }, "category": { "$ref": "#/components/schemas/OmniumAccountCategory" }, "taxGroupCode": { "type": "string", "description": "Filter by tax-group code.", "nullable": true }, "vatCode": { "type": "string", "description": "Filter by VAT code.", "nullable": true }, "currencyCode": { "type": "string", "description": "Filter by currency code.", "nullable": true }, "source": { "$ref": "#/components/schemas/OmniumPostingSource" }, "includeSuperseded": { "type": "boolean", "description": "When true, include lines whose parent posting has status Superseded.\r\nDefault false." }, "sortBy": { "type": "string", "description": "Sort field — \"PostingDate\" (default), \"AccountNumber\", or \"PostingId\".", "nullable": true }, "sortDescending": { "type": "boolean", "description": "When true, sort in descending order." } }, "additionalProperties": false, "description": "Search request for accounting ledger lines." }, "OmniumAccountingPosting": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique posting ID. Set by Omnium.", "nullable": true }, "source": { "$ref": "#/components/schemas/OmniumPostingSource" }, "orderType": { "type": "string", "description": "Order type this posting covers, when the tenant splits WebFulfillment postings per order\r\ntype. Null on per-store WebFulfillment postings and on all PosZReport postings.", "nullable": true }, "zReportId": { "type": "string", "description": "Z-report this posting was built from. Set when Source = PosZReport; null otherwise.", "nullable": true }, "zReportNumber": { "type": "integer", "description": "Z-report number, when applicable.", "format": "int64", "nullable": true }, "orderIds": { "type": "array", "items": { "type": "string" }, "description": "Order IDs that contributed to this posting.", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Stores covered by this posting. WebFulfillment postings have a single entry.", "nullable": true }, "registerIds": { "type": "array", "items": { "type": "string" }, "description": "Registers covered by the source Z-report. Empty for WebFulfillment postings.", "nullable": true }, "accountingCompanyCode": { "type": "string", "description": "Accounting company code (when configured per store/market).", "nullable": true }, "postingDate": { "type": "string", "description": "Accounting period date (store-local timezone → date component).", "format": "date-time" }, "createdAt": { "type": "string", "description": "UTC creation timestamp.", "format": "date-time" }, "currencyCode": { "type": "string", "description": "ISO currency code for the posting (e.g. NOK, SEK, EUR).", "nullable": true }, "status": { "type": "string", "description": "Lifecycle status. One of: Draft, Posted, Exported, Reconciled, Rejected, Superseded.", "nullable": true }, "supersedesPostingId": { "type": "string", "description": "If this posting replaces an earlier one, the ID of the superseded posting.", "nullable": true }, "externalReference": { "type": "string", "description": "ERP voucher ID once exported.", "nullable": true }, "exportedAt": { "type": "string", "description": "UTC timestamp when the posting was exported to the ERP, if exported.", "format": "date-time", "nullable": true }, "totalDebit": { "type": "number", "description": "Sum of all debit amounts on the posting's ledger lines.", "format": "decimal" }, "totalCredit": { "type": "number", "description": "Sum of all credit amounts on the posting's ledger lines.", "format": "decimal" }, "imbalance": { "type": "number", "description": "Signed imbalance (Debit - Credit). Should be 0 after auto-balancing.", "format": "decimal" }, "autoBalanced": { "type": "boolean", "description": "True if a suspense line was added to make the posting balance." }, "lineCount": { "type": "integer", "description": "Number of ledger lines on the posting.", "format": "int32" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Builder-emitted diagnostics (e.g. auto-balance notes).", "nullable": true }, "rejectionReason": { "type": "string", "description": "Operator-supplied reason recorded when the posting was transitioned to Rejected.", "nullable": true }, "postingHash": { "type": "string", "description": "Tamper-evidence hash over the ordered set of lines + identity fields.\r\nStable across lifecycle transitions (Status / ExportedAt etc. are excluded).", "nullable": true } }, "additionalProperties": false, "description": "An accounting posting (voucher header) summarising a balanced set of ledger lines.\r\nBuilt either from a POS Z-report close or from a daily web-fulfillment batch." }, "OmniumAccountingPostingOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAccountingPosting" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumAccountingPostingSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to return per page. Maximum 100.", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take]).", "format": "int32" }, "storeId": { "type": "string", "description": "Filter by store ID. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingPostingSearchRequest.StoreGroupId.", "nullable": true }, "storeGroupId": { "type": "string", "description": "Filter to postings covering any store in the given store group. The API resolves this\r\nto the set of store IDs that belong to the group. Mutually exclusive with Omnium.Public.Accounting.Models.OmniumAccountingPostingSearchRequest.StoreId.", "nullable": true }, "registerId": { "type": "string", "description": "Filter by register ID.", "nullable": true }, "accountingCompanyCode": { "type": "string", "description": "Filter by accounting company code.", "nullable": true }, "status": { "type": "string", "description": "Filter by posting status (Posted, Exported, Reconciled, Rejected).", "nullable": true }, "source": { "$ref": "#/components/schemas/OmniumPostingSource" }, "postingDateFrom": { "type": "string", "description": "Filter postings whose posting date is on or after this date (inclusive).", "format": "date-time", "nullable": true }, "postingDateTo": { "type": "string", "description": "Filter postings whose posting date is on or before this date (inclusive).", "format": "date-time", "nullable": true }, "orderIds": { "type": "array", "items": { "type": "string" }, "description": "Filter to postings that include any of the given order IDs.", "nullable": true }, "includeSuperseded": { "type": "boolean", "description": "When true, include postings with status Superseded (audit view).\r\nDefault false. Draft postings are never returned by the public API." } }, "additionalProperties": false, "description": "Search request for accounting postings." }, "OmniumAddProductOptionRequestValue": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Sku of the product options", "nullable": true }, "title": { "type": "string", "description": "Title of the product options", "nullable": true }, "value": { "type": "string", "description": "Value of the product options", "nullable": true }, "price": { "type": "number", "description": "Optional: Set a price for the product option. If price is not specific, the price from the product stored in Omnium will be used.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Model used when creating product options" }, "OmniumAddProductOptionsRequest": { "required": [ "cartId", "parentLineItemId", "productOptions" ], "type": "object", "properties": { "cartId": { "type": "string", "description": "Cart id for the existing cart" }, "parentLineItemId": { "type": "string", "description": "LineItemId for the existing product that you wish to add product options to" }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddProductOptionRequestValue" }, "description": "The list of product options to add" } }, "additionalProperties": false, "description": "For adding one or more product options to a product in cart" }, "OmniumAddRentalProductToCartRequest": { "required": [ "cartId", "rentalFrom", "rentalProductSkuId", "rentalTo" ], "type": "object", "properties": { "cartId": { "type": "string", "description": "Id of the cart to add the rental product to" }, "rentalProductSkuId": { "type": "string", "description": "The SKU ID of the rental product you wish to add to the cart" }, "rentalFrom": { "type": "string", "description": "The date and time the rental period begins", "format": "date-time" }, "rentalTo": { "type": "string", "description": "The date and time the rental period ends", "format": "date-time" }, "addDeposit": { "type": "boolean", "description": "Whether to add the deposit as a line item to the cart, default is true" } }, "additionalProperties": false, "description": "Request for adding a rental product as a line item to a cart" }, "OmniumAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of address (location / customer / business)", "nullable": true }, "line1": { "type": "string", "description": "Address line 1 (E.g. street address)", "nullable": true }, "line2": { "type": "string", "description": "Address line 2 (E.g. building number, floor, etc)", "nullable": true }, "streetNumber": { "type": "string", "description": "Street / House number - if not included in Line 1. See Customer settings", "nullable": true }, "apartmentNumber": { "type": "string", "description": "Apartment number", "nullable": true }, "city": { "type": "string", "description": "City (E.g. New York, Oslo, Tokyo)", "nullable": true }, "state": { "type": "string", "description": "State or county", "nullable": true }, "countryCode": { "type": "string", "description": "Country code", "nullable": true }, "countryName": { "type": "string", "description": "Country name", "nullable": true }, "postalCode": { "type": "string", "description": "Postal / ZIP code", "nullable": true }, "regionCode": { "type": "string", "description": "Region code (optional)", "nullable": true }, "regionName": { "type": "string", "description": "Region name (optional)", "nullable": true }, "purposes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Home/Billing/Invoice/++. This should not be set from a text field, but be selected from a set of configurable options.", "nullable": true }, "externalId": { "type": "string", "description": "Optional property - used for mapping addresses to other external systems", "nullable": true }, "email": { "type": "string", "description": "Optional property - Email address on billing address", "nullable": true }, "phone": { "type": "string", "description": "Optional property - Phone number on billing address", "nullable": true }, "locationName": { "type": "string", "description": "Name of location", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Address properties, (key values)", "nullable": true } }, "additionalProperties": false, "description": "Address class" }, "OmniumAddressSearchRequest": { "type": "object", "properties": { "purposes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Address must contain at least one of the supplied purposes", "nullable": true }, "zipCodeRanges": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumZipCodeRange" }, "description": "Zip code of address must be within one of the supplied ranges", "nullable": true } }, "additionalProperties": false, "description": "Search request object for OmniumAddress" }, "OmniumAnalyticsAddress": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "organization": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "apartmentNumber": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "countryName": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "regionCode": { "type": "string", "nullable": true }, "regionName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsContactPerson": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "phone": { "type": "string", "description": "Phone number", "nullable": true }, "email": { "type": "string", "description": "Email address", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles in company", "nullable": true }, "role": { "type": "string", "description": "Role in company (deprecated - use Roles instead for multiple roles support)", "nullable": true, "deprecated": true }, "privateCustomerId": { "type": "string", "description": "Private customer ID og the contact person (if ContactPerson is a registered customer)", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsCustomer": { "type": "object", "properties": { "customerId": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "customerName": { "type": "string", "nullable": true }, "customerType": { "type": "string", "nullable": true }, "customerEmail": { "type": "string", "nullable": true }, "customerPhone": { "type": "string", "nullable": true }, "salesPersonId": { "type": "string", "nullable": true }, "isCustomerClubMember": { "type": "boolean" } }, "additionalProperties": false }, "OmniumAnalyticsOrder": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The unique identifier for the order.", "nullable": true }, "orderNumber": { "type": "string", "description": "The number associated with the order.", "nullable": true }, "orderType": { "type": "string", "description": "The type of the order.", "nullable": true }, "status": { "type": "string", "description": "The current status of the order.", "nullable": true }, "salesPersonId": { "type": "string", "description": "The ID of the salesperson associated with the order.", "nullable": true }, "salesPersonName": { "type": "string", "description": "The name of the salesperson associated with the order.", "nullable": true }, "created": { "type": "string", "description": "The date the order was created.", "format": "date-time" }, "completed": { "type": "string", "description": "The date the order was completed (if applicable).", "format": "date-time", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAnalyticsPropertyItem" }, "description": "List of custom properties associated with the order.", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsOrderLine": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "market": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "orderLine": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineInfo" }, "shipment": { "$ref": "#/components/schemas/OmniumAnalyticsShipment" }, "order": { "$ref": "#/components/schemas/OmniumAnalyticsOrder" }, "returnOrder": { "$ref": "#/components/schemas/OmniumAnalyticsReturnOrder" }, "product": { "$ref": "#/components/schemas/OmniumAnalyticsProduct" }, "supplier": { "$ref": "#/components/schemas/OmniumAnalyticsSupplier" }, "customer": { "$ref": "#/components/schemas/OmniumAnalyticsCustomer" }, "promotion": { "$ref": "#/components/schemas/OmniumAnalyticsPromotion" }, "store": { "$ref": "#/components/schemas/OmniumAnalyticsStore" }, "warehouse": { "$ref": "#/components/schemas/OmniumAnalyticsStore" }, "pickupWarehouse": { "$ref": "#/components/schemas/OmniumAnalyticsStore" }, "returnWarehouse": { "$ref": "#/components/schemas/OmniumAnalyticsStore" }, "invoiceAddress": { "$ref": "#/components/schemas/OmniumAnalyticsAddress" }, "shippingAddress": { "$ref": "#/components/schemas/OmniumAnalyticsAddress" }, "payment": { "$ref": "#/components/schemas/OmniumAnalyticsPayment" }, "contactPerson": { "$ref": "#/components/schemas/OmniumAnalyticsContactPerson" }, "analyticsOrderLineType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsOrderLineGrouped": { "type": "object", "properties": { "group": { "type": "string", "description": "Aggregation group", "nullable": true }, "currency": { "type": "string", "description": "Currency for all quantities", "nullable": true }, "quantity": { "type": "number", "description": "Number of order lines", "format": "decimal" }, "deliveredQuantity": { "type": "number", "description": "Number of items delivered", "format": "decimal" }, "cancelledQuantity": { "type": "number", "description": "Number of items cancelled", "format": "decimal" }, "cost": { "type": "number", "description": "Order line cost", "format": "decimal" }, "revenue": { "type": "number", "description": "Order line revenue", "format": "decimal" }, "revenueExTax": { "type": "number", "description": "Order line revenue ex tax", "format": "decimal" }, "profit": { "type": "number", "description": "Order line profit", "format": "decimal" }, "profitAsPercentageOfRevenueExTax": { "type": "number", "description": "Profit in percent of revenue ex tax", "format": "decimal" } }, "additionalProperties": false, "description": "Quantities for order aggregations" }, "OmniumAnalyticsOrderLineGroupedOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGrouped" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumAnalyticsOrderLineGroupedSearchResponse": { "type": "object", "properties": { "searchResult": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGroupedOmniumSearchResult" }, "totals": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLineGrouped" } }, "additionalProperties": false, "description": "Response model for analytics search and aggregation data" }, "OmniumAnalyticsOrderLineInfo": { "type": "object", "properties": { "lineItemId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "skuId": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "decimal" }, "returnQuantity": { "type": "number", "format": "decimal" }, "discountedPrice": { "type": "number", "format": "decimal" }, "discountedPriceExclTax": { "type": "number", "format": "decimal" }, "taxRate": { "type": "number", "format": "decimal" }, "extendedPrice": { "type": "number", "format": "decimal" }, "extendedPriceExclTax": { "type": "number", "format": "decimal" }, "costTotal": { "type": "number", "format": "decimal" }, "profit": { "type": "number", "format": "decimal" }, "profitPercent": { "type": "number", "format": "decimal" }, "deliveredQuantity": { "type": "number", "format": "decimal" }, "deliveredDate": { "type": "string", "format": "date-time", "nullable": true }, "canceledQuantity": { "type": "number", "format": "decimal" }, "canceledDate": { "type": "string", "format": "date-time", "nullable": true }, "replacedQuantity": { "type": "number", "format": "decimal", "nullable": true }, "replacedDate": { "type": "string", "format": "date-time", "nullable": true }, "readyForPickupQuantity": { "type": "number", "format": "decimal", "nullable": true }, "readyForPickupDate": { "type": "string", "format": "date-time", "nullable": true }, "replacementType": { "type": "string", "nullable": true }, "replacementReason": { "type": "string", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAnalyticsPropertyItem" }, "description": "Properties", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsOrderLineOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAnalyticsOrderLine" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumAnalyticsOrderLineSearchRequest": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page number of the search results.", "format": "int32" }, "take": { "type": "integer", "description": "Number of records to retrieve per page.", "format": "int32" }, "sortOrder": { "type": "string", "description": "Sort order", "nullable": true }, "language": { "type": "string", "description": "Language filter", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Store IDs filter", "nullable": true }, "warehouseCodes": { "type": "array", "items": { "type": "string" }, "description": "Warehouse codes filter", "nullable": true }, "pickupWarehouseCodes": { "type": "array", "items": { "type": "string" }, "description": "Pickup warehouse codes filter", "nullable": true }, "countryNames": { "type": "array", "items": { "type": "string" }, "description": "Country name filter", "nullable": true }, "postalCodes": { "type": "array", "items": { "type": "string" }, "description": "Postal code filter", "nullable": true }, "citys": { "type": "array", "items": { "type": "string" }, "description": "City filter", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Market IDs filter", "nullable": true }, "currencies": { "type": "array", "items": { "type": "string" }, "description": "Currency filter", "nullable": true }, "shippingMethodNames": { "type": "array", "items": { "type": "string" }, "description": "Shipping method name filter", "nullable": true }, "customerNames": { "type": "array", "items": { "type": "string" }, "description": "Customer name filter", "nullable": true }, "supplierNames": { "type": "array", "items": { "type": "string" }, "description": "Supplier name filter", "nullable": true }, "shipmentDeliveryTypes": { "type": "array", "items": { "type": "string" }, "description": "Shipment delivery types filter (Pickup / Delivery)", "nullable": true }, "brands": { "type": "array", "items": { "type": "string" }, "description": "Brand filter", "nullable": true }, "sizes": { "type": "array", "items": { "type": "string" }, "description": "Size filter", "nullable": true }, "colors": { "type": "array", "items": { "type": "string" }, "description": "Color filter", "nullable": true }, "productTypes": { "type": "array", "items": { "type": "string" }, "description": "Product type filter", "nullable": true }, "productIds": { "type": "array", "items": { "type": "string" }, "description": "Product ID filter", "nullable": true }, "productNames": { "type": "array", "items": { "type": "string" }, "description": "Product name filter", "nullable": true }, "parentIds": { "type": "array", "items": { "type": "string" }, "description": "Parent ID filter", "nullable": true }, "productGenders": { "type": "array", "items": { "type": "string" }, "description": "Gender filter", "nullable": true }, "productCategory": { "type": "array", "items": { "type": "string" }, "description": "Product category name filter", "nullable": true }, "salesPersonIds": { "type": "array", "items": { "type": "string" }, "description": "Sales person ID filter", "nullable": true }, "salesPersonNames": { "type": "array", "items": { "type": "string" }, "description": "Sales person name filter", "nullable": true }, "mainProductCategory": { "type": "array", "items": { "type": "string" }, "description": "Main product category filter", "nullable": true }, "eanCodes": { "type": "array", "items": { "type": "string" }, "description": "EAN / GTIN filter", "nullable": true }, "skuIds": { "type": "array", "items": { "type": "string" }, "description": "SkuID filter", "nullable": true }, "customerIds": { "type": "array", "items": { "type": "string" }, "description": "Customer ID filter", "nullable": true }, "orderIds": { "type": "array", "items": { "type": "string" }, "description": "Order ID filter", "nullable": true }, "orderStatuses": { "type": "array", "items": { "type": "string" }, "description": "Order status filter", "nullable": true }, "orderLineDeliveryStatuses": { "type": "array", "items": { "type": "string" }, "description": "Order line delivery status filter", "nullable": true }, "orderTypes": { "type": "array", "items": { "type": "string" }, "description": "Order type filter", "nullable": true }, "orderNumbers": { "type": "array", "items": { "type": "string" }, "description": "Order number filter", "nullable": true }, "orderLineProperties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Order line properties filter", "nullable": true }, "orderProperties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Order properties filter", "nullable": true }, "paymentStatuses": { "type": "array", "items": { "type": "string" }, "description": "Payment status filter", "nullable": true }, "paymentMethodNames": { "type": "array", "items": { "type": "string" }, "description": "Payment method name filter", "nullable": true }, "promotionNames": { "type": "array", "items": { "type": "string" }, "description": "Promotion name filter", "nullable": true }, "contactPersonEmails": { "type": "array", "items": { "type": "string" }, "description": "Contact person e-mail filter", "nullable": true }, "contactPersonPhones": { "type": "array", "items": { "type": "string" }, "description": "Contact person phone filter", "nullable": true }, "createdFrom": { "type": "string", "description": "Created date from filter (orders crated after given date)", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Created date to filter (orders created before given date)", "format": "date-time", "nullable": true }, "completedFrom": { "type": "string", "description": "Completed date from filter (orders completed after given date)", "format": "date-time", "nullable": true }, "completedTo": { "type": "string", "description": "Completed date to filter (orders completed before given date)", "format": "date-time", "nullable": true }, "groupBy": { "type": "string", "description": "Group by (Property name from AnalyticsOrderLine. E.g. \"MainCategory\", \"SalesPersonName\", \"ProductName\", etc...)", "nullable": true }, "includeShipping": { "type": "boolean", "description": "Include shipping order lines" }, "includeReturns": { "type": "boolean", "description": "Include return order lines" }, "includeOrderLines": { "type": "boolean", "description": "Include order lines (default true)", "nullable": true }, "isOrderPropertiesIncluded": { "type": "boolean", "description": "Include order information" }, "isProductPropertiesIncluded": { "type": "boolean", "description": "Include product information" }, "isCustomerPropertiesIncluded": { "type": "boolean", "description": "Include customer information" }, "isPaymentPropertiesIncluded": { "type": "boolean", "description": "Include payment information" }, "isShipmentPropertiesIncluded": { "type": "boolean", "description": "Include shipment information" }, "isStorePropertiesIncluded": { "type": "boolean", "description": "Include store information" }, "isWarehousePropertiesIncluded": { "type": "boolean", "description": "Include warehouse information" }, "isPromotionPropertiesIncluded": { "type": "boolean", "description": "Include promotion information" }, "isSupplierPropertiesIncluded": { "type": "boolean", "description": "Include supplier information" }, "isShippingAddressPropertiesIncluded": { "type": "boolean", "description": "Include shipping address information" }, "isInvoiceAddressPropertiesIncluded": { "type": "boolean", "description": "Include invoice address information" }, "isContactPersonIncluded": { "type": "boolean", "description": "Include order contact person information" }, "isOrderDefaultPropertiesIncluded": { "type": "boolean", "description": "Include default properties from the order (Default property items are configurable in the configuration)" }, "searchText": { "type": "string", "description": "Free text search", "nullable": true } }, "additionalProperties": false, "description": "Search analytics orders (analytics must be activated in configuration to yield results)" }, "OmniumAnalyticsPayment": { "type": "object", "properties": { "paymentMethodName": { "type": "string", "nullable": true }, "paymentStatus": { "type": "string", "nullable": true }, "paymentDisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsProduct": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "skuId": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "size": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "productType": { "type": "string", "nullable": true }, "productId": { "type": "string", "nullable": true }, "parentId": { "type": "string", "nullable": true }, "ean": { "type": "string", "nullable": true }, "mainCategory": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "catalogNodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isExcludedFromAnalytics": { "type": "boolean" } }, "additionalProperties": false }, "OmniumAnalyticsPromotion": { "type": "object", "properties": { "promotionIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "promotionNames": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsPropertyItem": { "type": "object", "properties": { "key": { "type": "string", "description": "The key of the property.", "nullable": true }, "value": { "type": "string", "description": "The value of the property.", "nullable": true }, "valueType": { "type": "string", "description": "The type of the value.", "nullable": true }, "keyGroup": { "type": "string", "description": "The group to which the property belongs.", "nullable": true } }, "additionalProperties": false, "description": "Custom property item for order" }, "OmniumAnalyticsReturnOrder": { "type": "object", "properties": { "returnOrderId": { "type": "string", "nullable": true }, "rmaNumber": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniumAnalyticsShipment": { "type": "object", "properties": { "shippingMethodName": { "type": "string", "nullable": true }, "shipmentTrackingNumber": { "type": "string", "nullable": true }, "shipmentTrackingLink": { "type": "string", "nullable": true }, "shipmentDeliveryType": { "type": "string", "nullable": true }, "shippingLabel": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsStore": { "type": "object", "properties": { "storeId": { "type": "string", "nullable": true }, "storeName": { "type": "string", "nullable": true }, "storeGroupId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAnalyticsSupplier": { "type": "object", "properties": { "supplierId": { "type": "string", "nullable": true }, "supplierName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumAspectRatio": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "translateKey": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean", "nullable": true }, "height": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OmniumAsset": { "type": "object", "properties": { "parentId": { "type": "string", "description": "Optional - ID of parent media or directory", "nullable": true }, "assetId": { "type": "string", "description": "Optional - ID of asset. If not provided, an id will be generated", "nullable": true }, "assetType": { "type": "string", "description": "Optional - Type of asset", "nullable": true }, "sortOrder": { "type": "integer", "description": "Optional - Item sort index. Default is position in list", "format": "int32", "nullable": true }, "url": { "type": "string", "description": "Calculated: Omnium url", "nullable": true }, "externalUrl": { "type": "string", "description": "External URL (original URL, will be uploaded and Omnium url will be added to Url). If FileName is not provided, externalUrl has to contain the file extension (e.g. .jpg)", "nullable": true }, "fileName": { "type": "string", "description": "Preferred file name, used when uploaded to Omnium. Required to contain the correct file extension. File name and path from external URL will be used as fallback if null.", "nullable": true }, "isMainImage": { "type": "boolean", "description": "If true, asset will be used as main image on parent item" }, "name": { "type": "string", "description": "Optional - Asset name", "nullable": true }, "description": { "type": "string", "description": "Optional - Asset description", "nullable": true }, "altText": { "type": "string", "description": "Optional - Image alternative text", "nullable": true }, "purpose": { "type": "string", "description": "Optional - Asset purpose or use", "nullable": true }, "forceUpload": { "type": "boolean", "description": "Force upload external url to Omnium (if both external and internal url exists)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Optional - List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "created": { "type": "string", "description": "Date created", "format": "date-time" }, "modified": { "type": "string", "description": "Date modified", "format": "date-time" }, "contentType": { "type": "string", "description": "Calculated - File type, e.g. image/jpg", "nullable": true }, "length": { "type": "integer", "description": "Calculated - File size in bytes", "format": "int64" } }, "additionalProperties": false, "description": "" }, "OmniumAssortmentCode": { "type": "object", "properties": { "assortmentCodeId": { "type": "string", "description": "Id of the assortment code - could be anything", "nullable": true }, "validFrom": { "type": "string", "description": "Optional: Valid from date/time", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "description": "Optional: Valid to date/time", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Assortment code" }, "OmniumBusinessCustomer": { "required": [ "customerId" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of company", "nullable": true }, "taxId": { "type": "string", "description": "Tax ID, or other governmental identification number", "nullable": true }, "contacts": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons in company", "nullable": true }, "creditBalance": { "type": "number", "description": "(Obsolete) Customer's credit balance. Use BusinessCustomerCredit instead.", "format": "decimal", "nullable": true, "deprecated": true }, "creditLimit": { "type": "number", "description": "(Obsolete) Customer's credit limit. Use BusinessCustomerCredit instead.", "format": "decimal", "nullable": true, "deprecated": true }, "creditRemaining": { "type": "number", "description": "(Obsolete) Customer's remaining credits. Use BusinessCustomerCredit instead.", "format": "decimal", "nullable": true, "deprecated": true }, "isCreditDenied": { "type": "boolean", "description": "(Obsolete) Customer's credit is denied if true. Use BusinessCustomerCredit instead.", "nullable": true, "deprecated": true }, "discountGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of customers discount groups", "nullable": true }, "priceGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of customers price groups", "nullable": true }, "logo": { "$ref": "#/components/schemas/OmniumAsset" }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Omnium assets for business customer", "nullable": true }, "isAssortmentRestricted": { "type": "boolean", "description": "Set to 'true' if the business customer has a restricted assortment.\r\nThis is controlled by prices. If the customer has a customer specific price for a product, the product is automatically included in the customer's assortment.\r\nIf this is set to 'false', a non-customer specific price will be sufficient for the product to be part of the customer's assortment.", "nullable": true }, "punchOutUnitConversionList": { "type": "string", "description": "When using puch-out orders, unit conversion lists can be defined in settings. This reflects the corresponding Unit Conversion List for the customer.", "nullable": true }, "punchOutPropertyOverrides": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "When using puch-out orders, this list will provide information about property mapping", "nullable": true }, "punchOutDomain": { "type": "string", "description": "When using punch-out domain", "nullable": true }, "assortmentCodes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAssortmentCode" }, "description": "Assortment codes for the business customer - should match assortment products set on products. Product searches will by default use the customer's assortment codes to filter on products.", "nullable": true }, "notificationEmailAddresses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Emails for notifications (comma separated)", "nullable": true }, "notificationPhoneNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Phone numbers for notifications (comma separated)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for business customer", "nullable": true }, "businessCustomerCredit": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomerCredit" }, "description": "Credit information for customer on different markets", "nullable": true }, "customerId": { "type": "string", "description": "Unique ID" }, "customerNumber": { "type": "string", "description": "Customer identifier - does not have to be unique for each store, etc", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Customer additional addresses", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "url": { "type": "string", "description": "Customer url", "nullable": true }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Customer favorite stores", "nullable": true }, "marketId": { "type": "string", "description": "Customer primary market", "nullable": true }, "additionalMarketIds": { "maxLength": 100, "type": "array", "items": { "type": "string" }, "description": "Additional customer markets (beyond the primary MarketId)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Customer market group", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Preferred customer language code", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Customer preferred currency code (E.g. USD, NOK, EUR)", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external customer IDs", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, customer is available in all markets / stores", "nullable": true }, "modifiedBy": { "type": "string", "description": "Name of the user or system the last modified the item", "nullable": true }, "created": { "type": "string", "description": "Date and time the customer was created", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date and time the customer was modified", "format": "date-time", "nullable": true }, "isInactive": { "type": "boolean", "description": "True if customer is inactive, and should not be able to make purchases", "nullable": true }, "preferredShippingMethod": { "type": "string", "description": "Customer's preferred shipping method name (default selected in new carts)", "nullable": true }, "paymentTerms": { "type": "string", "description": "Payment terms (free text)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (days)", "format": "int32", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Customer groups", "nullable": true }, "consents": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Customer consents", "nullable": true }, "consentHistory": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsentHistory" }, "description": "Consent history", "nullable": true }, "customerDetails": { "type": "string", "description": "Customer details (brief summary for customer service representatives)", "nullable": true }, "customerRelations": { "maxLength": 2000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerRelation" }, "description": "Related customers", "nullable": true }, "assortmentIncludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to include in customer's assortment. Only products in these categories will be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true }, "assortmentExcludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from customer's assortment. Products in these categories will not be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true } }, "additionalProperties": false, "description": "Business customer (Company)" }, "OmniumBusinessCustomerCredit": { "type": "object", "properties": { "creditBalance": { "type": "number", "description": "Customer's credit balance", "format": "decimal", "nullable": true }, "creditLimit": { "type": "number", "description": "Customer's credit limit", "format": "decimal", "nullable": true }, "creditRemaining": { "type": "number", "description": "Customer's remaining credits", "format": "decimal", "nullable": true }, "isCreditDenied": { "type": "boolean", "description": "Customer's credit is denied if true", "nullable": true }, "creditCurrency": { "type": "string", "description": "Customer's credit currency", "nullable": true }, "marketId": { "type": "string", "description": "The market for the credit information", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the credit information for the customer", "nullable": true } }, "additionalProperties": false }, "OmniumBusinessCustomerOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumBusinessCustomerPatch": { "required": [ "customerId" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of company", "nullable": true }, "taxId": { "type": "string", "description": "Tax ID, or other governmental identification number", "nullable": true }, "contacts": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons in company", "nullable": true }, "creditBalance": { "type": "number", "description": "Customer's credit balance", "format": "decimal", "nullable": true }, "creditLimit": { "type": "number", "description": "Customer's credit limit", "format": "decimal", "nullable": true }, "creditRemaining": { "type": "number", "description": "Customer's remaining credits", "format": "decimal", "nullable": true }, "isCreditDenied": { "type": "boolean", "description": "Customer's credit is denied if true", "nullable": true }, "notificationEmailAddresses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Emails for notifications (comma separated)", "nullable": true }, "notificationPhoneNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Phone numbers for notifications (comma separated)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for business customer", "nullable": true }, "isAssortmentRestricted": { "type": "boolean", "description": "Set to 'true' if the business customer has a restricted assortment.\r\nThis is controlled by prices. If the customer has a customer specific price for a product, the product is automatically included in the customer's assortment.\r\nIf this is set to 'false', a non-customer specific price will be sufficient for the product to be part of the customer's assortment.", "nullable": true }, "punchOutUnitConversionList": { "type": "string", "description": "When using puch-out orders, unit conversion lists can be defined in settings. This reflects the corresponding Unit Conversion List for the customer.", "nullable": true }, "punchOutPropertyOverrides": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "When using puch-out orders, this list will provide information about property mapping", "nullable": true }, "punchOutDomain": { "type": "string", "description": "When using punch-out domain", "nullable": true }, "customerId": { "type": "string", "description": "Unique ID" }, "customerNumber": { "type": "string", "description": "Customer identifier - does not have to be unique for each store, etc", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Customer additional addresses", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "url": { "type": "string", "description": "Customer url", "nullable": true }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Customer favorite stores", "nullable": true }, "marketId": { "type": "string", "description": "Customer primary market", "nullable": true }, "additionalMarketIds": { "maxLength": 100, "type": "array", "items": { "type": "string" }, "description": "Additional customer markets (beyond the primary MarketId)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Customer market group", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Preferred customer language code", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Customer preferred currency code (E.g. USD, NOK, EUR)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external customer IDs", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, customer is available in all markets / stores", "nullable": true }, "isInactive": { "type": "boolean", "description": "True if customer is inactive, and should not be able to make purchases", "nullable": true }, "preferredShippingMethod": { "type": "string", "description": "Customer's preferred shipping method name (default selected in new carts)", "nullable": true }, "paymentTerms": { "type": "string", "description": "Payment terms (free text)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (days)", "format": "int32", "nullable": true }, "customerGroups": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Customer groups", "nullable": true }, "consents": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Customer consents", "nullable": true }, "customerDetails": { "type": "string", "description": "Customer details (brief summary for customer service representatives)", "nullable": true }, "customerRelations": { "maxLength": 2000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerRelation" }, "description": "Related customers", "nullable": true } }, "additionalProperties": false, "description": "Business customer patch request" }, "OmniumCampaign": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the campaign.", "nullable": true }, "name": { "type": "string", "description": "Campaign display name.", "nullable": true }, "description": { "type": "string", "description": "Optional internal description of the campaign.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing and filtering campaigns.", "nullable": true }, "startDate": { "type": "string", "description": "Campaign start date.", "format": "date-time" }, "endDate": { "type": "string", "description": "Campaign end date.", "format": "date-time" }, "status": { "type": "string", "description": "Current lifecycle status of the campaign.\r\nValid values: Planning, Active, Completed, Archived", "nullable": true }, "markets": { "type": "array", "items": { "type": "string" }, "description": "Markets where the campaign applies.", "nullable": true }, "stores": { "type": "array", "items": { "type": "string" }, "description": "Stores where the campaign applies. Empty means all stores.", "nullable": true }, "planningNotes": { "type": "string", "description": "Internal notes for campaign planning.", "nullable": true }, "createdDate": { "type": "string", "description": "Timestamp when the campaign was created.", "format": "date-time", "nullable": true }, "updatedDate": { "type": "string", "description": "Timestamp when the campaign was last updated.", "format": "date-time", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for extensibility.", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of validation or processing errors.", "nullable": true }, "internalComments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Internal comments on this campaign (employee-to-employee).", "nullable": true } }, "additionalProperties": false, "description": "Represents a campaign in the public API." }, "OmniumCampaignOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCampaign" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumCampaignRequest": { "required": [ "endDate", "name", "startDate" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id of the campaign. A GUID will be generated if not provided.", "nullable": true }, "name": { "type": "string", "description": "Campaign display name." }, "description": { "type": "string", "description": "Optional internal description of the campaign.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing and filtering campaigns.", "nullable": true }, "startDate": { "type": "string", "description": "Campaign start date.", "format": "date-time" }, "endDate": { "type": "string", "description": "Campaign end date. Must be after StartDate.", "format": "date-time" }, "status": { "type": "string", "description": "Initial lifecycle status of the campaign.\r\nValid values: Planning, Active, Completed, Archived. Defaults to Planning if not specified.", "nullable": true }, "markets": { "type": "array", "items": { "type": "string" }, "description": "Markets where the campaign applies.", "nullable": true }, "stores": { "type": "array", "items": { "type": "string" }, "description": "Stores where the campaign applies. Empty means all stores.", "nullable": true }, "planningNotes": { "type": "string", "description": "Internal notes for campaign planning.", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for extensibility.", "nullable": true } }, "additionalProperties": false, "description": "Request model for creating or updating a campaign." }, "OmniumCampaignSearchRequest": { "type": "object", "properties": { "startFrom": { "type": "string", "description": "Filter campaigns that start after this date.\r\nOnly campaigns where StartDate >= StartFrom will be included.", "format": "date-time", "nullable": true }, "startTo": { "type": "string", "description": "Filter campaigns that start before this date.\r\nOnly campaigns where StartDate <= StartTo will be included.", "format": "date-time", "nullable": true }, "endFrom": { "type": "string", "description": "Filter campaigns that end after this date.\r\nOnly campaigns where EndDate >= EndFrom will be included.", "format": "date-time", "nullable": true }, "endTo": { "type": "string", "description": "Filter campaigns that end before this date.\r\nOnly campaigns where EndDate <= EndTo will be included.", "format": "date-time", "nullable": true }, "statuses": { "type": "array", "items": { "type": "string" }, "description": "Filter by campaign statuses. Empty means all statuses.\r\nValid values: Planning, Active, Completed, Archived", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by market IDs.", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Filter by tags.", "nullable": true }, "searchText": { "type": "string", "description": "Free-text search across name, description, and tags.", "nullable": true }, "campaignIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by specific campaign IDs.", "nullable": true }, "page": { "type": "integer", "description": "Page number for pagination. Defaults to 1.", "format": "int32" }, "take": { "type": "integer", "description": "Number of results per page. Defaults to 20.", "format": "int32" }, "sortOrder": { "type": "string", "description": "Sort order. Options: StartDateAsc, StartDateDesc, EndDateAsc, EndDateDesc, NameAsc, NameDesc.", "nullable": true }, "excludeArchived": { "type": "boolean", "description": "If true, excludes archived campaigns from results. Defaults to true." } }, "additionalProperties": false, "description": "Represents a search request for campaigns in the system." }, "OmniumCampaignStatusUpdate": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "The new status for the campaign.\r\nValid values: Planning, Active, Completed, Archived" } }, "additionalProperties": false, "description": "Request model for updating a campaign's status." }, "OmniumCancelPurchaseOrderLinesRequest": { "type": "object", "properties": { "lineItemIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of the purchase order lines to cancel. Each matched line has its remaining,\r\nundelivered quantity cancelled. IDs not found on the purchase order are ignored.", "nullable": true } }, "additionalProperties": false, "description": "Request to cancel multiple lines on a single purchase order in one call." }, "OmniumCart": { "type": "object", "properties": { "id": { "type": "string", "description": "Cart unique ID", "nullable": true }, "expiredDate": { "type": "string", "description": "Expiration date of cart. If passed, the cart should not be visible to customer.", "format": "date-time", "nullable": true }, "isReadOnly": { "type": "boolean", "description": "Should the cart be read only?" }, "isReadOnlyByCustomer": { "type": "boolean", "description": "Should the order/cart be read only for the customer?" }, "ignorePromotions": { "type": "boolean", "description": "Should promotion prices be ignored when product is added to cart?", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer groups (for discount calculation)", "nullable": true }, "orderStatus": { "type": "string", "description": "Should be used when order needs a special status when created from cart", "nullable": true }, "orderNumber": { "type": "string", "description": "In most cases, this property will be identical to the Id property.\r\nHowever, if you have orders from multiple sources (multiple e-commerce sites, pos systems or other sales channels),\r\nand the order numbers from the sources could overlap, you could set the Id to a unique value and the order number to the user friendly number.", "nullable": true }, "customerId": { "type": "string", "description": "The ID of the customer that has placed the order. Typically this is set to the customers phone number or email address, but it could be set to anything.\r\nA customer with the matching ID does not have to exist in the system before the order is placed.\r\nIf there are no overlapping IDs, but you still have multiple sources of IDs, consider using ExternalIds instead.", "nullable": true }, "customerNumber": { "type": "string", "description": "In most cases, the customer number could be set to the same value as the CustomerId.\r\nHowever, in some edge cases the customers could get imported from multiple systems with the same ID range. In that case,\r\nyou should set the user friendly number to the CustomerNumber and an unique ID for the CustomerId.", "nullable": true }, "customerClubMemberId": { "type": "string", "description": "If Customer is member of customer club, set Customer ID as member ID.", "nullable": true }, "billingCurrency": { "type": "string", "description": "Currency of the order. e.g. \"USD\",\"NOK\"", "nullable": true }, "customerName": { "type": "string", "description": "Full name of customer", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone number with prefix. e.g. +4740000000", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "customerType": { "type": "string", "description": "B2B or B2C (Business customer or private customer)", "nullable": true }, "marketId": { "type": "string", "description": "Market ID e.g. \"US\", \"NOR\", \"SWE\". This must match the value of the market(s) defined in Omnium.", "nullable": true }, "billingAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "orderForm": { "$ref": "#/components/schemas/OmniumOrderForm" }, "orderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, for internal use / not for customer", "nullable": true }, "publicOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, visible for customer", "nullable": true }, "shippingDiscountTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Shipping discount amount", "format": "decimal", "deprecated": true }, "shippingSubTotal": { "type": "number", "description": "Total shipping cost", "format": "decimal", "deprecated": true }, "status": { "type": "string", "description": "The current order status. This must match a status defined in the order settings in Omnium.\r\nTypical values are \"New\", \"InProgress\", \"Cancelled\" or \"Completed\".", "nullable": true }, "remainingPayment": { "type": "number", "description": "CALCULATED: The remaining payment amount if the difference between the authorized amount and total amount", "format": "decimal" }, "salesPersonId": { "type": "string", "description": "Id of seller of the order - typically set to the e-mail of the user in Omnium, but could be set to any ID.", "nullable": true }, "salesPersonName": { "type": "string", "description": "Name of the seller of the order", "nullable": true }, "salesChannel": { "type": "string", "description": "Name of sales channel", "nullable": true }, "completed": { "type": "string", "description": "CALCULATED: Order completed date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "CALCULATED: Order last modified date", "format": "date-time" }, "modifiedBy": { "type": "string", "description": "CALCULATED: Modified by", "nullable": true }, "created": { "type": "string", "description": "The creation date of the order", "format": "date-time" }, "received": { "type": "string", "description": "The received date of the order", "format": "date-time", "nullable": true }, "followUpDate": { "type": "string", "description": "Order follow-up date", "format": "date-time", "nullable": true }, "customerPickupDeadline": { "type": "string", "description": "CALCULATED: Customer deadline for picking up order", "format": "date-time", "nullable": true }, "storePickDate": { "type": "string", "description": "CALCULATED: Employee deadline for picking order", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Delivery date requested by customer", "format": "date-time", "nullable": true }, "updateStatusDate": { "type": "string", "description": "Date when order should be moved to next status. (Updated by UpdateOrderStatusScheduledTask)", "format": "date-time", "nullable": true }, "readyForPickup": { "type": "string", "description": "Calculated: When the order was set to ready for pickup. The property can be set by workflow step with name: Set ready for pickup date", "format": "date-time", "nullable": true }, "nextOrderStatus": { "type": "string", "description": "Status order should be moved to. (Updated by UpdateOrderStatusScheduledTask)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "paymentType": { "type": "string", "description": "OBSOLETE: Use orderForm.payments instead.", "nullable": true, "deprecated": true }, "orderType": { "type": "string", "description": "Order type e.g. \"Online\", \"Pos\". The order type must match a order type defined in the Omnium order settings", "nullable": true }, "storeId": { "type": "string", "description": "The store Id identifies the store that sells the orders. Should match an ID of an existing store.\r\nA store would typically be the front end e-commerce solution, a physical store or other sales channels.", "nullable": true }, "returnOrderForms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderForm" }, "description": "The returns for the current order. An order could have one or multiple return order forms.", "nullable": true }, "orderOrigin": { "type": "string", "description": "The origin of the order should identify where the order was created. Typical values are \"OMS\", \"ERP\", \"WEB\" or \"POS\".", "nullable": true }, "lineItemsCost": { "type": "number", "description": "Calculated: Total cost of the order. The cost price", "format": "decimal" }, "netTotal": { "type": "number", "description": "Calculated: OrderForm total - returnForms total", "format": "decimal" }, "netTotalExclTax": { "type": "number", "description": "Calculated: OrderForm total excl tax - returnForms total excl tax", "format": "decimal" }, "customerReference": { "type": "string", "description": "Reference provided by customer.", "nullable": true }, "customerContact": { "type": "string", "description": "Customer contact person", "nullable": true, "deprecated": true }, "customerRequisition": { "type": "string", "description": "Customer requisition provided by customer", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/OmniumContactPerson" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external IDs. External IDs are visible in Omnium's UI and useful for display, searching and filtering on IDs originating from other systems.\r\nA typical use case could be to add the IDs from ERP/POS/E-COM systems that does not match the order ID in order to simplify integration and traceability", "nullable": true }, "isNotificationsDisabled": { "type": "boolean", "description": "If true, Omnium's notifications will not be triggered for the order" }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the current order.", "nullable": true }, "relatedOrders": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of related order IDs", "nullable": true }, "session": { "type": "string", "description": "Session code used for referencing a web session", "nullable": true }, "secretKey": { "type": "string", "description": "A unique secret key for the order. Can be used for secure order lookups.", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Order assets (documents, media, files)", "nullable": true }, "replacementOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of replacement order IDs for this order", "nullable": true }, "subscriptionId": { "type": "string", "description": "Subscription ID - used if order is part of a subscription. The Id should match an existing subscription in Omnium", "nullable": true }, "projectIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Project IDs - used if order is part of projects", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Order tags (Used by notification filters, and for grouping / filtering orders)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (in days). Used for invoice due dates.", "format": "int32", "nullable": true }, "invoiceComment": { "type": "string", "description": "Invoice comment", "nullable": true }, "projectId": { "type": "string", "description": "OBSOLETE: Use ProjectIds instead. Project ID - used if order is part of a project", "nullable": true, "deprecated": true }, "subTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost", "format": "decimal", "deprecated": true }, "subTotalExclTax": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost and without tax", "format": "decimal", "deprecated": true }, "taxTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Total tax amount", "format": "decimal", "deprecated": true }, "total": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost, tax, and discounts", "format": "decimal", "deprecated": true }, "totalExclTax": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost and discounts, but without tax", "format": "decimal", "deprecated": true }, "discountTotalIncVat": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Total order discount", "format": "decimal", "deprecated": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderGroup" }, "description": "Order line groups", "nullable": true }, "isNewCustomer": { "type": "boolean", "description": "Indicates whether the customer is new. Set automatically by the workflow if the customer's creation date is in the past, \r\nbut can also be updated via the API.", "nullable": true }, "versionId": { "type": "string", "description": "Read only: Current version ID", "nullable": true }, "name": { "type": "string", "description": "Order name", "nullable": true }, "canceled": { "type": "string", "description": "Canceled date", "format": "date-time", "nullable": true }, "orgNr": { "type": "string", "description": "Organization number", "nullable": true }, "correlationId": { "type": "string", "description": "Correlation ID for tracing", "nullable": true }, "isAnonymized": { "type": "boolean", "description": "Whether the order has been anonymized" }, "isReservable": { "type": "boolean", "description": "Whether the order is reservable", "nullable": true }, "pendingNotificationIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPendingNotification" }, "description": "Pending notifications that should be picked up by the notification scheduler.\r\nWhen the notification has been sent, the notification ID will be removed from the list.", "nullable": true }, "invoiceIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of invoice IDs associated with this order", "nullable": true }, "documentStatus": { "type": "string", "description": "Shows which documents have been generated for the order", "nullable": true }, "customerOrderNumber": { "type": "string", "description": "Customer's own order number", "nullable": true }, "isReallocated": { "type": "boolean", "description": "Whether the order has been reallocated" } }, "additionalProperties": false, "description": "The cart class is the main class used for handling both carts and offers given to a customer. Could be online carts, or offers from physical stores" }, "OmniumCartCheckoutRequest": { "type": "object", "properties": { "validators": { "type": "array", "items": { "type": "string" }, "description": "Optional list of validator names to run during checkout.\r\nIf null (or omitted), all configured validators will be executed.\r\nIf an empty array, no validators will be run (the consumer has opted out of validation).\r\nIf non-empty, only the named validators will be run.\r\nUse GET /api/carts/Validators to discover available validator names.", "nullable": true }, "orderId": { "type": "string", "description": "Optional. Consumer-specified ID for the resulting order.\r\nWhen set, this value is used as the order ID directly (and as the order number),\r\nbypassing any fallback to cart.OrderNumber, tenant settings or auto-generation.\r\nWhen not set (null or empty), Omnium generates the order ID automatically\r\nusing the tenant's configured order number service.", "nullable": true }, "cartPatch": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "additionalProperties": false, "description": "Request model for checking out a cart (converting it to an order).\r\nOptionally applies a cart patch (which can also add/replace payments or shipments) in the same operation." }, "OmniumCartCheckoutResult": { "type": "object", "properties": { "patchResult": { "$ref": "#/components/schemas/OmniumOrderPatchUpdateResult" }, "value": { "$ref": "#/components/schemas/OmniumOrder" }, "isValidatedSuccessful": { "type": "boolean" }, "validationErrors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationWarnings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationMessage": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Result of a cart checkout operation. Contains validation information\r\nand, on success, the created order." }, "OmniumCartCommentRequest": { "type": "object", "properties": { "cartId": { "type": "string", "description": "Cart ID", "nullable": true }, "commentType": { "$ref": "#/components/schemas/OmniumCommentType" }, "commentText": { "type": "string", "description": "The comment text/message content", "nullable": true }, "createdBy": { "type": "string", "description": "The sender/creator of the comment (e.g., external user, system or sales channel).\r\nDefaults to the current's API user's username", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/filtering comments", "nullable": true }, "marketId": { "type": "string", "description": "Market ID (optional, uses cart's market if not specified)", "nullable": true }, "sendEmail": { "type": "boolean", "description": "Send email notification to customer" }, "emailSubject": { "type": "string", "description": "Email subject line", "nullable": true }, "emailTo": { "type": "string", "description": "Email recipient address. Falls back to cart's customer email if not specified.", "nullable": true }, "emailCc": { "type": "string", "description": "Email CC recipients (semicolon separated)", "nullable": true }, "emailBcc": { "type": "string", "description": "Email BCC recipients (semicolon separated)", "nullable": true }, "emailFrom": { "type": "string", "description": "Email from address. Falls back to store's default email if not specified.", "nullable": true }, "senderName": { "type": "string", "description": "Sender display name for email and SMS notifications. Falls back to store's default sender name if not specified.", "nullable": true }, "sendSms": { "type": "boolean", "description": "Send SMS notification to customer" }, "smsPhoneNumber": { "type": "string", "description": "Phone number for SMS. Falls back to cart's customer phone if not specified.", "nullable": true } }, "additionalProperties": false, "description": "Request model for adding a comment to a cart" }, "OmniumCartExportRequest": { "required": [ "cartIds" ], "type": "object", "properties": { "connectorId": { "type": "string", "description": "The connector ID to export carts to, for example \"f60203b3-82fa-4f5c-8578-7777d4faf5e4\"", "nullable": true }, "connectorName": { "type": "string", "description": "Exporter name, the name of the exporter for example \"sitoo\", \"shopify\"", "nullable": true }, "cartIds": { "minLength": 1, "type": "array", "items": { "type": "string" }, "description": "List of cart IDs to export" } }, "additionalProperties": false, "description": "Request model for exporting carts to a connector" }, "OmniumCartOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCart" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumCartOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCart" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumCartOmniumValidationResult": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/OmniumCart" }, "isValidatedSuccessful": { "type": "boolean" }, "validationErrors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationWarnings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumCartResponseModel": { "type": "object", "properties": { "cart": { "$ref": "#/components/schemas/OmniumCart" }, "validationResults": { "$ref": "#/components/schemas/OmniumValidationResult" } }, "additionalProperties": false, "description": "Cart response with validation" }, "OmniumCartSearchRequest": { "type": "object", "properties": { "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter for store IDs", "nullable": true }, "customerId": { "type": "string", "description": "Filter by customer", "nullable": true }, "name": { "type": "string", "description": "Filter by cart name (Not to be confused with customer name)", "nullable": true }, "customerContact": { "type": "string", "description": "Filter by contact person", "nullable": true }, "projectId": { "type": "string", "description": "Filter by project", "nullable": true }, "changedSince": { "type": "string", "description": "Filter by changed date", "format": "date-time", "nullable": true }, "createdFrom": { "type": "string", "description": "Filter by created from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Filter by created to date", "format": "date-time", "nullable": true }, "salesPersonId": { "type": "string", "description": "Filter by sales person ID", "nullable": true }, "statuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by cart statuses", "nullable": true }, "isActiveOnly": { "type": "boolean", "description": "Get only active carts" }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude tags", "nullable": true }, "orderTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Order types", "nullable": true }, "followUpDateFrom": { "type": "string", "description": "Orders with follow-up from date", "format": "date-time", "nullable": true }, "followUpDateTo": { "type": "string", "description": "Orders with follow-up to date", "format": "date-time", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List with custom properties to search for", "nullable": true }, "marketIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter for market IDs", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order for the results. Defaults to modified date descending.\r\nPossible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, CustomerNameAscending, CustomerNameDescending\r\nStatusAscending, StatusDescending, CartIdAscending, CartIdDescending, StoreAscending, StoreDescending, TotalAscending, TotalDescending\r\nand DocumentID. If you do not care about the order you should use DocumentId", "nullable": true }, "lineItemSalesOriginId": { "type": "string", "description": "Filter to only include carts that have at least one order line with a SalesOriginId matching the given value", "nullable": true }, "searchQuery": { "type": "string", "description": "Free text search query", "nullable": true }, "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" } }, "additionalProperties": false, "description": "Cart search request" }, "OmniumCartTemplate": { "type": "object", "properties": { "id": { "type": "string", "description": "Cart template ID", "nullable": true }, "cart": { "$ref": "#/components/schemas/OmniumCart" }, "salesPersonId": { "type": "string", "description": "Sales person ID", "nullable": true }, "salesPersonName": { "type": "string", "description": "Sales person name", "nullable": true }, "modified": { "type": "string", "description": "Modified", "format": "date-time" }, "created": { "type": "string", "description": "Created", "format": "date-time" }, "name": { "type": "string", "description": "Name of the cart template", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Additional properties / meta data", "nullable": true } }, "additionalProperties": false, "description": "A cart templates contains a cart and meta data" }, "OmniumCartTemplateCreateCartRequest": { "type": "object", "properties": { "cartTemplateId": { "type": "string", "description": "ID of the cart template that will be used to create a new cart", "nullable": true } }, "additionalProperties": false, "description": "Cart template creation request" }, "OmniumCartTemplateOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCartTemplate" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumCartTemplateSearchRequestModel": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to fetch. Defaults to 10", "format": "int32" }, "page": { "type": "integer", "description": "Current page (for paging). Defaults to 1", "format": "int32" }, "query": { "type": "string", "description": "Free text query", "nullable": true }, "cartTemplateId": { "type": "string", "description": "Filter by cart template ID", "nullable": true }, "cartTemplateName": { "type": "string", "description": "Filter by cart template name", "nullable": true }, "salesPersonId": { "type": "string", "description": "Filter by sales person Id", "nullable": true }, "createdFrom": { "type": "string", "description": "Filter by creation from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Filter by creation to date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Cart templates search request" }, "OmniumCartUpdateRequest": { "type": "object", "properties": { "cartId": { "type": "string", "description": "ID of cart to edit", "nullable": true }, "marketId": { "type": "string", "description": "Market ID for new cart - default market if null", "nullable": true }, "storeId": { "type": "string", "description": "Store ID for new cart - defaults to null", "nullable": true }, "customerId": { "type": "string", "description": "CustomerId for the new cart - defaults to null", "nullable": true }, "lineItemRequests": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemUpdateRequest" }, "description": "List of Product SKU ids and quantity (defaults to 1 if not provided). (Required)", "nullable": true }, "priceStoreId": { "type": "string", "description": "If set here, it applies to all items in LineItemRequests\r\nunless a specific {PriceStoreId} is provided at the line item level.", "nullable": true } }, "additionalProperties": false }, "OmniumCartValidationRequest": { "type": "object", "properties": { "validators": { "type": "array", "items": { "type": "string" }, "description": "Optional list of validator names to execute.\r\nIf null or empty, all configured validators will be executed.\r\nUse GET /api/carts/Validators to discover available validator names.", "nullable": true } }, "additionalProperties": false, "description": "Request model for validating a cart with optional validator selection" }, "OmniumCase": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Case ID. Is set by Omnium.", "nullable": true }, "caseNumber": { "type": "string", "description": "Case number", "nullable": true }, "subject": { "type": "string", "description": "Case subject / title", "nullable": true }, "description": { "type": "string", "description": "Case description", "nullable": true }, "status": { "type": "string", "description": "Case status (e.g. New, Open, Resolved, Closed)", "nullable": true }, "priority": { "type": "string", "description": "Case priority (e.g. Low, Medium, High, Critical)", "nullable": true }, "source": { "type": "string", "description": "Source of the case (e.g. Email, Phone, Web)", "nullable": true }, "assignedToUserId": { "type": "string", "description": "User ID of the assigned agent", "nullable": true }, "assignedToName": { "type": "string", "description": "Display name of the assigned agent", "nullable": true }, "customerName": { "type": "string", "description": "Name of the customer associated with the case", "nullable": true }, "customerEmail": { "type": "string", "description": "Email of the customer associated with the case", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID associated with the case", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with the case", "nullable": true }, "relatedOrders": { "type": "array", "items": { "type": "string" }, "description": "Related order IDs", "nullable": true }, "relatedCustomers": { "type": "array", "items": { "type": "string" }, "description": "Related customer IDs", "nullable": true }, "relatedProjects": { "type": "array", "items": { "type": "string" }, "description": "Related project IDs", "nullable": true }, "relatedCarts": { "type": "array", "items": { "type": "string" }, "description": "Related cart IDs", "nullable": true }, "relatedSkuIds": { "type": "array", "items": { "type": "string" }, "description": "Related SKU IDs (product variant codes)", "nullable": true }, "relatedProductIds": { "type": "array", "items": { "type": "string" }, "description": "Related product IDs", "nullable": true }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCaseParticipant" }, "description": "Case participants", "nullable": true }, "caseNotes": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Case notes (visible to customer)", "nullable": true }, "internalNotes": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Internal notes (not visible to customer)", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "created": { "type": "string", "description": "Date case was created (UTC)", "format": "date-time" }, "changed": { "type": "string", "description": "Date case was last modified (UTC)", "format": "date-time" }, "followUpDate": { "type": "string", "description": "Case follow-up date", "format": "date-time", "nullable": true }, "resolvedDate": { "type": "string", "description": "Date case was resolved (UTC)", "format": "date-time", "nullable": true }, "closedDate": { "type": "string", "description": "Date case was closed (UTC)", "format": "date-time", "nullable": true }, "lastCommentDate": { "type": "string", "description": "Date of the last comment on the case (UTC)", "format": "date-time", "nullable": true }, "lastCommenterName": { "type": "string", "description": "Name of the last person who commented", "nullable": true }, "commentCount": { "type": "integer", "description": "Total number of comments on the case", "format": "int32" }, "marketId": { "type": "string", "description": "Market ID associated with the case", "nullable": true }, "marketGroupId": { "type": "string", "description": "Market group ID associated with the case", "nullable": true }, "caseStatusLog": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCaseStatusLogItem" }, "description": "Status change timeline for the case", "nullable": true } }, "additionalProperties": false, "description": "Class containing information for cases, e.g. a support case or customer inquiry" }, "OmniumCaseOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCase" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumCaseParticipant": { "type": "object", "properties": { "email": { "type": "string", "description": "Participant email address", "nullable": true }, "name": { "type": "string", "description": "Participant display name", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID of the participant", "nullable": true }, "role": { "type": "string", "description": "Role of the participant (e.g. Reporter, Observer)", "nullable": true } }, "additionalProperties": false, "description": "Participant in a case" }, "OmniumCasePatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Case ID (required)", "nullable": true }, "subject": { "type": "string", "description": "Case subject / title", "nullable": true }, "description": { "type": "string", "description": "Case description", "nullable": true }, "status": { "type": "string", "description": "Case status", "nullable": true }, "priority": { "type": "string", "description": "Case priority", "nullable": true }, "source": { "type": "string", "description": "Source of the case", "nullable": true }, "assignedToUserId": { "type": "string", "description": "User ID of the assigned agent", "nullable": true }, "assignedToName": { "type": "string", "description": "Display name of the assigned agent", "nullable": true }, "customerName": { "type": "string", "description": "Name of the customer associated with the case", "nullable": true }, "customerEmail": { "type": "string", "description": "Email of the customer associated with the case", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID associated with the case", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags associated with the case", "nullable": true }, "relatedOrders": { "type": "array", "items": { "type": "string" }, "description": "Related order IDs", "nullable": true }, "relatedCustomers": { "type": "array", "items": { "type": "string" }, "description": "Related customer IDs", "nullable": true }, "relatedProjects": { "type": "array", "items": { "type": "string" }, "description": "Related project IDs", "nullable": true }, "relatedCarts": { "type": "array", "items": { "type": "string" }, "description": "Related cart IDs", "nullable": true }, "relatedSkuIds": { "type": "array", "items": { "type": "string" }, "description": "Related SKU IDs (product variant codes)", "nullable": true }, "relatedProductIds": { "type": "array", "items": { "type": "string" }, "description": "Related product IDs", "nullable": true }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCaseParticipant" }, "description": "Case participants", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "followUpDate": { "type": "string", "description": "Case follow-up date", "format": "date-time", "nullable": true }, "marketId": { "type": "string", "description": "Market ID associated with the case", "nullable": true }, "marketGroupId": { "type": "string", "description": "Market group ID associated with the case", "nullable": true } }, "additionalProperties": false, "description": "Patch model for partial case updates. Only non-null values will be applied." }, "OmniumCaseSearchRequest": { "type": "object", "properties": { "status": { "type": "string", "description": "Filter by case status", "nullable": true }, "priority": { "type": "string", "description": "Filter by case priority", "nullable": true }, "assignedToUserId": { "type": "string", "description": "Filter by assigned user ID", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "customerId": { "type": "string", "description": "Filter by customer ID", "nullable": true }, "orderId": { "type": "string", "description": "Filter by related order ID", "nullable": true }, "dateFrom": { "type": "string", "description": "Filter cases created after this date", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "description": "Filter cases created before this date", "format": "date-time", "nullable": true }, "searchText": { "type": "string", "description": "Free text search", "nullable": true }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "includeDeleted": { "type": "boolean", "description": "Include soft-deleted cases in results" }, "sortOrder": { "type": "string", "description": "Sort order", "nullable": true } }, "additionalProperties": false, "description": "Search request for cases" }, "OmniumCaseStatusLogItem": { "type": "object", "properties": { "status": { "type": "string", "description": "The status the case entered at this point in the timeline.", "nullable": true }, "timestamp": { "type": "string", "description": "The exact time when the case first entered this status.\r\nStored in UTC.", "format": "date-time" }, "durationSincePreviousMs": { "type": "integer", "description": "The duration in milliseconds since the previous status was recorded.\r\nNull for the first status.", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Represents a single step in a case's status timeline, including the timestamp of the status change and the duration since the previous step." }, "OmniumCashManagement": { "type": "object", "properties": { "cashIn": { "type": "number", "description": "Opening cash amount when the register was opened.", "format": "decimal" }, "cashSalesRefunds": { "type": "number", "description": "Net cash from sales and refunds during the register period.", "format": "decimal" }, "cashPetty": { "type": "number", "description": "Petty cash withdrawals (small expenses paid from register).", "format": "decimal" }, "cashBank": { "type": "number", "description": "Cash deposited to bank during the register period.", "format": "decimal" }, "cashExpected": { "type": "number", "description": "Calculated expected cash amount in the register (opening + sales - refunds - petty - bank).", "format": "decimal" }, "cashCounted": { "type": "number", "description": "Actual cash amount counted when closing the register.", "format": "decimal" }, "cashDiff": { "type": "number", "description": "Difference between expected and counted cash (CashCounted - CashExpected).\r\nPositive indicates overage, negative indicates shortage.", "format": "decimal" }, "cashBankFinal": { "type": "number", "description": "Final amount deposited to bank after closing.", "format": "decimal" }, "cashOut": { "type": "number", "description": "Cash removed from register when closing (e.g., for deposit or safe).", "format": "decimal" } }, "additionalProperties": false, "description": "Represents cash management details for a cash register, tracking expected vs. actual cash amounts." }, "OmniumCategoryAndBrandFilter": { "type": "object", "properties": { "categories": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "nullable": true }, "requiredCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "nullable": true }, "excludedCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "nullable": true }, "brands": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedBrands": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "products": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionProduct" }, "nullable": true }, "excludedProducts": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionProduct" }, "nullable": true }, "seasons": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedSeasons": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true }, "excludedProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true } }, "additionalProperties": false }, "OmniumChangeCustomerId": { "required": [ "fromCustomerId", "toCustomerId" ], "type": "object", "properties": { "fromCustomerId": { "type": "string" }, "toCustomerId": { "type": "string" } }, "additionalProperties": false }, "OmniumCharge": { "type": "object", "properties": { "code": { "type": "string", "description": "Charge code / identifier", "nullable": true }, "amount": { "type": "number", "description": "Charge amount", "format": "decimal" } }, "additionalProperties": false, "description": "Omnium order charge object" }, "OmniumChart": { "type": "object", "properties": { "chartData": { "$ref": "#/components/schemas/OmniumChartData" }, "chartType": { "type": "string", "description": "Chart type", "nullable": true } }, "additionalProperties": false, "description": "Class for displaying generic charts from Omnium" }, "OmniumChartData": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" }, "description": "This typically is dates - 01.01, 01.02 / Jan, feb / 2018 , 2019", "nullable": true }, "datasets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumChartDataset" }, "description": "Chart dataset", "nullable": true } }, "additionalProperties": false, "description": "Class containing generic Omnium Charts with labels and data sets" }, "OmniumChartDataset": { "type": "object", "properties": { "label": { "type": "string", "description": "The text that is displayed on the bar/pie slice/line - for example a store name, product name/id, 'Revenue' or 'Cost'", "nullable": true }, "data": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Chart data", "nullable": true } }, "additionalProperties": false, "description": "Chart data set" }, "OmniumClaim": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Claim project ID", "nullable": true }, "projectType": { "type": "string", "description": "Project type ID for claim", "nullable": true } }, "additionalProperties": false, "description": "Class containing connection between a claim project and a return" }, "OmniumComment": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID", "nullable": true }, "objectId": { "type": "string", "description": "Id of object to which the comment is related (i.e. projectId if a ObjectType is Project)", "nullable": true }, "objectType": { "type": "string", "description": "The type of object to which the comment is related (Available types: [Project])", "nullable": true }, "type": { "type": "string", "description": "Specifies type of comment (Available types: [ProjectCustomerComment, ProjectInternalComment, ProjectPartnerComment])", "nullable": true }, "created": { "type": "string", "description": "Comment created date", "format": "date-time" }, "customerId": { "type": "string", "description": "Comment customer ID", "nullable": true }, "detail": { "type": "string", "description": "Comment main content", "nullable": true }, "title": { "type": "string", "description": "Comment header", "nullable": true }, "lineItemId": { "type": "string", "description": "Optional line item reference", "nullable": true }, "creator": { "type": "string", "description": "Name of comment creator", "nullable": true }, "userId": { "type": "string", "description": "ID of comment creator", "nullable": true }, "attachments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "List of attachments", "nullable": true }, "parentId": { "type": "string", "description": "Parent comment ID", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Comment tags (for categories / anchors / threads)", "nullable": true }, "sendNotification": { "type": "boolean", "description": "Send out notification. Requires delivery method and recipient(-s)", "nullable": true }, "deliveryMethod": { "type": "string", "description": "Type of notification (Available types: [Email, Sms, EmailAndSms])", "nullable": true }, "emailRecipient": { "type": "string", "description": "Recipient of email notification (must be valid email address)", "nullable": true }, "smsRecipient": { "type": "string", "description": "Recipient of sms notification (must be valid phone number)", "nullable": true }, "emailFromName": { "type": "string", "description": "Name displayed as sender of the email", "nullable": true }, "emailFromAddress": { "type": "string", "description": "Email address displayed as sender of the email", "nullable": true }, "emailSubject": { "type": "string", "description": "Email subject", "nullable": true }, "smsFrom": { "type": "string", "description": "Name displayed as sender of the sms (if empty - set to StandardSmsSender from settings)", "nullable": true } }, "additionalProperties": false, "description": "Object used for adding and getting comments on all models" }, "OmniumCommentPatch": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of comment to patch" }, "objectId": { "type": "string", "description": "Id of object to which the comment is related (i.e. projectId if a ObjectType is Project)", "nullable": true }, "objectType": { "type": "string", "description": "The type of object to which the comment is related (Available types: [Project])", "nullable": true }, "type": { "type": "string", "description": "Specifies type of comment (Available types: [ProjectCustomerComment, ProjectInternalComment, ProjectPartnerComment])", "nullable": true }, "customerId": { "type": "string", "description": "Comment customer ID", "nullable": true }, "detail": { "type": "string", "description": "Comment main content", "nullable": true }, "title": { "type": "string", "description": "Comment header", "nullable": true }, "lineItemId": { "type": "string", "description": "Optional line item reference", "nullable": true }, "creator": { "type": "string", "description": "Name of comment creator", "nullable": true }, "userId": { "type": "string", "description": "ID of comment creator", "nullable": true }, "attachments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "List of attachments", "nullable": true }, "parentId": { "type": "string", "description": "Parent comment ID", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Comment tags (for categories / anchors / threads)", "nullable": true } }, "additionalProperties": false, "description": "Object used for patching specific comment values" }, "OmniumCommentSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "objectIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "objectTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "commentTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumCommentType": { "enum": [ "Public", "Internal" ], "type": "string", "description": "Type of comment" }, "OmniumCompletionRateFilter": { "type": "object", "properties": { "min": { "type": "integer", "description": "Minimum completion rate percentage (0-100)", "format": "int32", "nullable": true }, "max": { "type": "integer", "description": "Maximum completion rate percentage (0-100)", "format": "int32", "nullable": true }, "isValid": { "type": "boolean", "description": "Filter by completion validity. True returns only products where all required fields are filled in. False returns only products missing required fields.", "nullable": true }, "field": { "type": "string", "description": "Filter by a specific field name to check if it is completed or not. Use together with IsCompleted.", "nullable": true }, "isCompleted": { "type": "boolean", "description": "When used with Field: true returns products where the field is completed, false returns products where the field is not completed.", "nullable": true }, "isSkuOnly": { "type": "boolean", "description": "Only check for existing values on SKU's. If enabled, this will only retrieve products where the selected field is 'completed' for all variants or SKU's.", "nullable": true } }, "additionalProperties": false, "description": "Filter options for product completion rate" }, "OmniumCompletionStatus": { "type": "object", "properties": { "isValid": { "type": "boolean", "description": "Whether the product meets all required field criteria", "nullable": true }, "points": { "type": "number", "description": "Current completion points", "format": "double", "nullable": true }, "maxPoints": { "type": "number", "description": "Maximum possible completion points", "format": "double", "nullable": true }, "percentage": { "type": "number", "description": "Completion percentage (0-100)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Completion status for a product, tracking whether required fields are filled in." }, "OmniumComponentOption": { "type": "object", "properties": { "skuId": { "type": "string", "description": "The SKU ID of the selectable option.", "nullable": true }, "productId": { "type": "string", "description": "The product ID associated with this option. Only required if SkuId is not specified. This allows all variants of a product to be valid options.", "nullable": true }, "priceOffsets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "Relevant only for packages (not bundles).\r\nPrice offsets applied to the package price when this option is selected. \r\nOffsets can be positive or negative, indicating that the price is added to or deducted from the package price. \r\nIf no offsets are defined, the option does not affect the package price.", "nullable": true } }, "additionalProperties": false, "description": "Represents a selectable option for a package component." }, "OmniumConditionalPricingSettings": { "type": "object", "properties": { "showPricesOnlyWhenConditionMet": { "type": "boolean", "description": "Show promotional prices on product pages only when condition is met.\r\nWhen false, promotional prices are shown immediately (traditional behavior)." } }, "additionalProperties": false, "description": "Configuration settings for conditional pricing behavior in MultiBuy promotions" }, "OmniumConditionOperator": { "enum": [ "And", "Or" ], "type": "string", "description": "Defines how multiple promotion conditions are combined" }, "OmniumConsent": { "type": "object", "properties": { "date": { "type": "string", "description": "Date of consent", "format": "date-time", "nullable": true }, "type": { "type": "string", "description": "Consent type. Could have any value.", "nullable": true }, "content": { "type": "string", "description": "Content / text describing consent given-", "nullable": true }, "description": { "type": "string", "description": "Consent description", "nullable": true }, "source": { "type": "string", "description": "Consent source. E.g. Web, PoS, customer service call, etc.", "nullable": true }, "status": { "type": "boolean", "description": "True if active" }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "MarketIds for access control of consents", "nullable": true } }, "additionalProperties": false, "description": "Used for storing GDPR constens. All customers can have multiple consents of any kind." }, "OmniumConsentHistory": { "type": "object", "properties": { "date": { "type": "string", "description": "Date of consent", "format": "date-time", "nullable": true }, "type": { "type": "string", "description": "Consent type. Could have any value.", "nullable": true }, "content": { "type": "string", "description": "Content / text describing consent given-", "nullable": true }, "description": { "type": "string", "description": "Consent description", "nullable": true }, "source": { "type": "string", "description": "Consent source. E.g. Web, PoS, customer service call, etc.", "nullable": true }, "status": { "type": "boolean", "description": "True if active" }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "MarketIds for access control of consents", "nullable": true } }, "additionalProperties": false, "description": "Store historic consents" }, "OmniumContactPerson": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "phone": { "type": "string", "description": "Phone number", "nullable": true }, "email": { "type": "string", "description": "E-mail", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles in company", "nullable": true }, "role": { "type": "string", "description": "Role in company (deprecated - use Roles instead for multiple roles support)", "nullable": true, "deprecated": true }, "notify": { "type": "boolean", "description": "True if this contact person receive notifications" }, "isPrimaryContact": { "type": "boolean", "description": "True if person is primary contact person for company" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external contact person IDs", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Contact properties, (key values)", "nullable": true }, "id": { "type": "string", "description": "Contact person ID", "nullable": true }, "privateCustomerId": { "type": "string", "description": "Reference to private customer. Used to connect contact person to private customer as a private person with consents, addresses, etc.", "nullable": true } }, "additionalProperties": false, "description": "Person class. Used for contact persons in businesses." }, "OmniumCoordinate": { "type": "object", "properties": { "srId": { "type": "string", "nullable": true }, "northing": { "type": "number", "format": "float" }, "easting": { "type": "number", "format": "float" } }, "additionalProperties": false }, "OmniumCostPrice": { "type": "object", "properties": { "cost": { "type": "number", "description": "The cost price, including discount amount. Cost or OriginalCost is required. The other will be calculated based on DiscountAmount.", "format": "decimal", "nullable": true }, "originalCost": { "type": "number", "description": "The original cost price before discount.", "format": "decimal", "nullable": true }, "currencyCode": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "productId": { "type": "string", "description": "Calculated: ProductId of product.", "nullable": true }, "skuId": { "type": "string", "description": "The SkuId the cost price is valid for. If empty, the cost price will be linked to the product, and be valid for all variants.", "nullable": true }, "ean": { "type": "string", "description": "The ean the cost price is valid for", "nullable": true }, "unit": { "type": "string", "description": "The unit the cost price is valid for", "nullable": true }, "supplier": { "type": "string", "description": "The related supplier for the cost price", "nullable": true }, "type": { "type": "string", "description": "The type of cost price - if you have different types of cost prices", "nullable": true }, "marketId": { "type": "string", "description": "Market ID the cost price is valid in", "nullable": true }, "marketGroupId": { "type": "string", "description": "Market group ID the cost price is valid in", "nullable": true }, "storeId": { "type": "string", "description": "Store ID the cost price is valid in", "nullable": true }, "storeGroupId": { "type": "string", "description": "Store group ID the cost price is valid in", "nullable": true }, "validFrom": { "type": "string", "description": "Cost price available from this date", "format": "date-time", "nullable": true }, "validUntil": { "type": "string", "description": "Cost price available until this date", "format": "date-time", "nullable": true }, "discountAmount": { "type": "number", "description": "Discount amount", "format": "decimal", "nullable": true }, "discountCode": { "type": "string", "description": "Name of discount campaign", "nullable": true }, "modified": { "type": "string", "description": "When the price was last modified", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Product cost price" }, "OmniumCostPriceDeleteRequest": { "type": "object", "properties": { "costPrices": { "maxLength": 10000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPrice" }, "description": "Cost prices to delete. If list is null, all cost prices for the product will be deleted. If list is empty, no cost prices will be deleted for the product.", "nullable": true }, "productId": { "type": "string", "description": "Products ProductId to delete cost prices for", "nullable": true } }, "additionalProperties": false }, "OmniumCostPriceOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPrice" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumCostPriceSearchRequest": { "type": "object", "properties": { "lastModified": { "type": "string", "description": "Set LastModified to a specific DateTime to get items only modified after that time", "format": "date-time", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Filter prices on market IDs", "nullable": true }, "storeGroupId": { "type": "string", "description": "Filter prices on store group ID", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Filter prices on store IDs", "nullable": true }, "productCodes": { "type": "array", "items": { "type": "string" }, "description": "Filter prices on product codes (SKU / Product ID)", "nullable": true }, "validFrom": { "type": "string", "description": "Filter prices on valid from date. If null, the search will not filter by this property.", "format": "date-time", "nullable": true }, "validUntil": { "type": "string", "description": "Filter prices on valid until date. If null, the search will not filter by this property.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Contains all parameters for doing a cost price search." }, "OmniumCostPriceUpdateRequest": { "type": "object", "properties": { "costPrices": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPrice" }, "description": "Cost prices to add or update", "nullable": true }, "productId": { "type": "string", "description": "Products ProductId to update cost prices for", "nullable": true }, "ignoreDates": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates. If false, only prices with exact same dates will be overridden." }, "ignoreValidUntilDate": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates for the \"ValidUntil\" property, but will still need an exact match for the \"ValidFrom\" property. This will only work if \"IgnoreDates\" is set to \"false\"." } }, "additionalProperties": false }, "OmniumCurrencyConversions": { "type": "object", "properties": { "currencyCode": { "type": "string", "description": "The currency code of the foreign currency (3-letter ISO 4217, e.g., \"EUR\", \"GBP\", \"NOK\").", "nullable": true }, "moneyExpected": { "type": "number", "description": "The calculated expected amount for cash in the register in the foreign currency before counting.", "format": "decimal" }, "moneyCounted": { "type": "number", "description": "The actual counted amount for cash in the register in the foreign currency when closing.", "format": "decimal" }, "moneyExpectedBase": { "type": "number", "description": "The expected amount converted to the base/default currency of the register.", "format": "decimal" }, "moneyCountedBase": { "type": "number", "description": "The counted amount converted to the base/default currency of the register.", "format": "decimal" } }, "additionalProperties": false, "description": "Represents foreign currency conversion details for registers handling multiple currencies." }, "OmniumCustomerClubConsents": { "type": "object", "properties": { "approvedConsents": { "type": "boolean", "description": "Has customer approved consents" }, "smsMarketing": { "type": "boolean", "description": "Has customer approved sms marketing" }, "emailMarketing": { "type": "boolean", "description": "Has customer approved email marketing" } }, "additionalProperties": false, "description": "Consents for customer club" }, "OmniumCustomerClubInterests": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the interest", "nullable": true }, "displayName": { "type": "string", "description": "User friendly name of the interest", "nullable": true }, "languageCode": { "type": "string", "description": "two letter lang code. Used if interest is only valid for one language/market", "nullable": true } }, "additionalProperties": false, "description": "List of Interest the user can subscribe to" }, "OmniumCustomerClubMember": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Unique customerId", "nullable": true }, "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "customerName": { "type": "string", "description": "Full name of customer", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "birthDate": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "memberSince": { "type": "string", "description": "When the membership started", "format": "date-time" }, "membersshipApproved": { "type": "string", "description": "When the membership was approved by customer(can be null if customer has not approved yet)", "format": "date-time", "nullable": true }, "membershipEndDate": { "type": "string", "description": "When the membership ended", "format": "date-time", "nullable": true }, "summary": { "$ref": "#/components/schemas/OmniumCustomerClubPointsSummary" }, "tier": { "$ref": "#/components/schemas/OmniumCustomerClubMemberTier" }, "consents": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" }, "customerClubConsents": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "nullable": true }, "consentHistory": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsentHistory" }, "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Property list", "nullable": true }, "validPoints": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubValidPoints" }, "description": "List of valid points, with created and expire dates", "nullable": true }, "interests": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer selected Interests", "nullable": true }, "salesPersonId": { "type": "string", "description": "Id of the person who recruited the member", "nullable": true }, "storeId": { "type": "string", "description": "Id of signup store", "nullable": true }, "marketId": { "type": "string", "description": "Customer market", "nullable": true } }, "additionalProperties": false, "description": "Class for customer club member" }, "OmniumCustomerClubMemberOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerClubMember" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumCustomerClubMemberPatchRequest": { "type": "object", "properties": { "consents": { "$ref": "#/components/schemas/OmniumCustomerClubConsents" }, "interests": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Interests. This will override existing interests", "nullable": true }, "storeId": { "type": "string", "description": "Signup store id, could we webShop, or a physical store", "nullable": true } }, "additionalProperties": false, "description": "Used to update a customerClub member, with consents and interests" }, "OmniumCustomerClubMemberSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Paged search - number of items to retrieve", "format": "int32" }, "page": { "type": "integer", "description": "Paged search - page", "format": "int32" }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs", "nullable": true }, "marketIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Filter by market IDs", "nullable": true }, "customerIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter by customerIds", "nullable": true }, "emailMarketingConsent": { "type": "boolean", "description": "Filter by value of email marketing consent", "nullable": true } }, "additionalProperties": false, "description": "Customer club member search request" }, "OmniumCustomerClubMemberTier": { "type": "object", "properties": { "tierId": { "type": "string", "description": "Id for the tier", "nullable": true }, "name": { "type": "string", "description": "Name for the tier", "nullable": true }, "tierStart": { "type": "string", "description": "Date for when the customer entered the Tier/Level", "format": "date-time", "nullable": true }, "tierEnd": { "type": "string", "description": "Date for when the customer will leave the Tier/Level", "format": "date-time", "nullable": true }, "tierSummary": { "$ref": "#/components/schemas/OmniumCustomerClubMemberTierSummary" } }, "additionalProperties": false }, "OmniumCustomerClubMemberTierSummary": { "type": "object", "properties": { "amount": { "type": "number", "description": "Current tier amount", "format": "decimal", "nullable": true }, "amountToNextTier": { "type": "number", "description": "Amount to reach next tier", "format": "decimal", "nullable": true }, "numberOfOrders": { "type": "integer", "description": "Number of order in current tier perios", "format": "int32", "nullable": true } }, "additionalProperties": false }, "OmniumCustomerClubPointsSummary": { "type": "object", "properties": { "currentBalance": { "type": "number", "description": "Points available for usage", "format": "decimal" }, "newPointsOnHold": { "type": "number", "description": "Points created by orders that are not prosessed", "format": "decimal" }, "reservedPoints": { "type": "number", "description": "Used points by orders that are not prosessed", "format": "decimal" }, "totalIssuedPoints": { "type": "number", "description": "Total issued points for this member", "format": "decimal" }, "usedPoints": { "type": "number", "description": "Total points used for this member", "format": "decimal" }, "expiredPoints": { "type": "number", "description": "Points that has expired, and can not be used any more", "format": "decimal" } }, "additionalProperties": false, "description": "Summary for customer club member. Balance, used points, reserved points etc" }, "OmniumCustomerClubValidPoints": { "type": "object", "properties": { "pointAmount": { "type": "number", "description": "Amount of points valid for this periode", "format": "decimal" }, "created": { "type": "string", "description": "When points was generated", "format": "date-time" }, "expireDate": { "type": "string", "description": "When points will expire", "format": "date-time" }, "orderId": { "type": "string", "description": "OrderId for this points. Can be empty if manually given", "nullable": true }, "skuIds": { "type": "array", "items": { "type": "string" }, "description": "ProductIds for this points, Can be empty if manually given", "nullable": true } }, "additionalProperties": false, "description": "Class with information about valid points, and expire date" }, "OmniumCustomerCommentRequest": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Customer ID (e.g., email address or customer number)", "nullable": true }, "commentText": { "type": "string", "description": "The comment text/message content", "nullable": true }, "createdBy": { "type": "string", "description": "The sender/creator of the comment (e.g., \"API\", \"System\", external service name).\r\nDefaults to \"API\" if not specified.", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/filtering comments", "nullable": true }, "marketId": { "type": "string", "description": "Market ID (optional, uses customer's market if not specified)", "nullable": true }, "sendEmail": { "type": "boolean", "description": "Send email notification to customer" }, "emailSubject": { "type": "string", "description": "Email subject line", "nullable": true }, "emailTo": { "type": "string", "description": "Email recipient address. Falls back to customer's email if not specified.", "nullable": true }, "emailCc": { "type": "string", "description": "Email CC recipients (semicolon separated)", "nullable": true }, "emailBcc": { "type": "string", "description": "Email BCC recipients (semicolon separated)", "nullable": true }, "emailFrom": { "type": "string", "description": "Email from address. Falls back to store's default email if not specified.", "nullable": true }, "senderName": { "type": "string", "description": "Sender display name for email and SMS notifications. Falls back to store's default sender name if not specified.", "nullable": true }, "sendSms": { "type": "boolean", "description": "Send SMS notification to customer" }, "smsPhoneNumber": { "type": "string", "description": "Phone number for SMS. Falls back to customer's phone if not specified.", "nullable": true } }, "additionalProperties": false, "description": "Request model for adding a comment to a customer" }, "OmniumCustomerConsents": { "type": "object", "properties": { "customerId": { "type": "string", "description": "Id of the customer the consents should be added to.", "nullable": true }, "consents": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Consents to add for the customer. Existing consents of the same type are updated.", "nullable": true } }, "additionalProperties": false, "description": "A single entry in a batch consent request: the customer to update and the consents to add for that customer." }, "OmniumCustomerGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "Customer group ID", "nullable": true }, "name": { "type": "string", "description": "Customer group name", "nullable": true }, "displayName": { "type": "string", "description": "Customer group display name", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "Customer group external Ids", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer group properties", "nullable": true }, "created": { "type": "string", "description": "Customer group created date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Customer group modified date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Customer group" }, "OmniumCustomerGroupOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroup" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumCustomerGroupReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Customer group ID", "nullable": true }, "name": { "type": "string", "description": "Customer group name", "nullable": true } }, "additionalProperties": false, "description": "Customer group reference" }, "OmniumCustomerGroupSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "customerGroupIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of Ids for customer groups to retrieve", "nullable": true }, "createdFrom": { "type": "string", "description": "Created from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Created to date", "format": "date-time", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "External Ids", "nullable": true }, "searchText": { "type": "string", "description": "Search text", "nullable": true } }, "additionalProperties": false, "description": "Customer group search request" }, "OmniumCustomerRelation": { "type": "object", "properties": { "customerId": { "type": "string", "description": "ID of the customer referenced", "nullable": true }, "customerType": { "type": "string", "description": "Customer type (B2B, B2C)", "nullable": true }, "relationType": { "type": "string", "description": "Relation type (InvoiceReceiver, GoodsReceiver, etc - configurable in settings)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External IDs", "nullable": true } }, "additionalProperties": false, "description": "Customer reference for defining customers relations" }, "OmniumCustomerSearchRequest": { "type": "object", "properties": { "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter for store IDs", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter for market IDs", "nullable": true }, "marketGroupIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter for market group IDs", "nullable": true }, "isMarketGroupIdsRequired": { "type": "boolean", "description": "Set to 'true' to exclude customers without any MarketGroupId set. If 'false', customers without market group IDs will be returned when market group ID filter is used", "nullable": true }, "isStoreIdsRequired": { "type": "boolean", "description": "Set to 'true' to exclude customers without any Store IDs set. If 'false', customers without store IDs will be returned when store ID filter is used", "nullable": true }, "storeGroupId": { "type": "string", "description": "Filter by store group ID (will override StoreIds if set)", "nullable": true }, "customerId": { "type": "string", "description": "Filter by customer", "nullable": true }, "customerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by multiple customer IDs", "nullable": true }, "customerNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by multiple customer numbers", "nullable": true }, "customerGroups": { "type": "array", "items": { "type": "string" }, "description": "Filter by customer groups", "nullable": true }, "createdFrom": { "type": "string", "description": "Customer created from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Customer created before date", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Customer modified from date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Customer modified before date", "format": "date-time", "nullable": true }, "taxId": { "type": "string", "description": "Filter by customer", "nullable": true }, "email": { "type": "string", "description": "Filter by customer email", "nullable": true }, "phone": { "type": "string", "description": "Filter by customer phone", "nullable": true }, "query": { "type": "string", "description": "Search by free text query", "nullable": true }, "searchStoreGroups": { "type": "boolean", "description": "If true, search will include all stores with same store group ID as for the stores with given StoreIds" }, "isInactive": { "type": "boolean", "description": "If true, search will include all customers marked as inactive. If false all customers marked as inactive will be excluded. Null returns all.", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, search will include all customers marked as global. If false all customers marked as global will be excluded. Null returns all.", "nullable": true }, "isCustomerClubMember": { "type": "boolean", "description": "If true, search will only include customers that are members of a customer club. If false, only non-members. Null returns all", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by external IDs", "nullable": true }, "consentTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of consent types. Will filter customers for any active consent of given types.", "nullable": true }, "projectTypeId": { "type": "string", "description": "Filter on customers available as partners on a project type. (Only available on business customer search)", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order (ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by excluding tags", "nullable": true }, "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List with custom properties to search for", "nullable": true } }, "additionalProperties": false, "description": "Customer search request" }, "OmniumCustomerSettings": { "type": "object", "properties": { "isB2BGetOrCreateFromOrderDisabled": { "type": "boolean" }, "isB2CGetOrCreateFromOrderDisabled": { "type": "boolean" }, "isB2BGetOrCreateDisabled": { "type": "boolean" }, "isB2CGetOrCreateDisabled": { "type": "boolean" }, "punchOutSettings": { "$ref": "#/components/schemas/OmniumPunchOutSettings" }, "requiredAddressProperties": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDefaultPropertyItem" }, "nullable": true }, "useExternalBonusPointsProvider": { "type": "boolean" }, "useStatsCustomerQueues": { "type": "boolean", "description": "If set, private customers will be copied to statsCustomers" }, "tagSettings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTagSettings" }, "nullable": true } }, "additionalProperties": false }, "OmniumCustomerUpdateResult": { "type": "object", "properties": { "isModified": { "type": "boolean", "description": "True if at least one property on the customer was changed by the patch operation." }, "totalCount": { "type": "integer", "description": "Total number of customers processed by the operation.", "format": "int32" }, "updatedCount": { "type": "integer", "description": "Number of customers that were modified and persisted.", "format": "int32" }, "unchangedCount": { "type": "integer", "description": "Number of customers that were processed but had no changes to apply.", "format": "int32" }, "notFoundCount": { "type": "integer", "description": "Number of customers that could not be found and were therefore skipped.", "format": "int32" }, "notFoundIds": { "type": "array", "items": { "type": "string" }, "description": "Ids of customers that could not be found and were therefore skipped. Null for single-customer operations.", "nullable": true }, "errorCount": { "type": "integer", "description": "Number of customers where the update failed due to an error.", "format": "int32" }, "errorMessage": { "type": "string", "description": "Concatenated error messages for any customers that failed to update. Each entry includes the customer id and the underlying error.", "nullable": true } }, "additionalProperties": false, "description": "Result of a customer patch/update operation, summarising how many records were processed and the outcome of each." }, "OmniumCustomSortIndex": { "type": "object", "properties": { "value": { "type": "number", "description": "The sort value.", "format": "double" }, "marketId": { "type": "string", "description": "Relevant market ID for the current sort index", "nullable": true } }, "additionalProperties": false, "description": "Custom sort index for sorting on custom values such as popularity" }, "OmniumDatePlanner": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "datePlannerItems": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDatePlannerItem" }, "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "OmniumDatePlannerItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "isRange": { "type": "boolean" }, "isTimeSpanEnabled": { "type": "boolean" }, "timeFrom": { "type": "string", "nullable": true, "example": "00:00:00" }, "timeTo": { "type": "string", "nullable": true, "example": "00:00:00" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumDefaultDimensions": { "type": "object", "properties": { "lengthInCm": { "type": "integer", "description": "Length in cm", "format": "int32" }, "widthInCm": { "type": "integer", "description": "Width in cm", "format": "int32" }, "heightInCm": { "type": "integer", "description": "Height in cm", "format": "int32" } }, "additionalProperties": false, "description": "Default package dimensions" }, "OmniumDefaultPackage": { "type": "object", "properties": { "weightInKg": { "type": "number", "description": "Default package weight in kg. Can be changed on a order/cart", "format": "double" }, "defaultDimensions": { "$ref": "#/components/schemas/OmniumDefaultDimensions" }, "goodsDescription": { "type": "string", "description": "Default goods description", "nullable": true } }, "additionalProperties": false, "description": "Default package info sent to provider. Used if no specific info is added on cart/order" }, "OmniumDefaultPropertyItem": { "type": "object", "properties": { "valueOptions": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "For predefined options (multiselect)", "nullable": true }, "isCustomValueOptionAllowed": { "type": "boolean", "description": "Allow adding custom values." }, "isMultiSelectEnabled": { "type": "boolean", "description": "Only relevant for the \"DropDown\" valueType. If true, multiple values can be selected." }, "readOnly": { "type": "boolean", "description": "Make property read only" }, "propertyOptionGroup": { "type": "string", "description": "Name of a centrally managed PropertyOption group whose values should populate this dropdown.\r\nWhen set, takes precedence over ValueOptions.", "nullable": true }, "key": { "type": "string", "description": "Property key", "nullable": true }, "value": { "type": "string", "description": "Property value", "nullable": true }, "valueType": { "type": "string", "description": "Data type (Number, Xhtml, String, DateTime, Boolean, etc)", "nullable": true }, "keyGroup": { "type": "string", "description": "For grouping properties", "nullable": true } }, "additionalProperties": false }, "OmniumDeleteRentalProductsRequest": { "required": [ "productIds" ], "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string" }, "description": "The rental products to delete" }, "reclaimInventory": { "type": "boolean", "description": "When true, the inventory will be reclaimed to the warehouse set in the\r\n`ReclaimToWarehouse` field" }, "reclaimToWarehouse": { "type": "string", "description": "The Warehouse to reclaim inventory to", "nullable": true } }, "additionalProperties": false, "description": "Request for deleting rental products" }, "OmniumDelivery": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the delivery.", "nullable": true }, "modified": { "type": "string", "description": "Date and time when the delivery was last modified.", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "Date and time when the delivery was created.", "format": "date-time", "nullable": true }, "isCounted": { "type": "boolean", "description": "Indicates whether the delivery quantity has been verified before goods reception." }, "deliveryTrackingNumber": { "type": "string", "description": "Tracking number associated with the delivery.", "nullable": true }, "deliveryTrackingLink": { "type": "string", "description": "Tracking link associated with the delivery.", "nullable": true }, "warehouseCode": { "type": "string", "description": "Code of the receiving warehouse associated with the delivery.", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Code of the supplier warehouse associated with the delivery (Internal transfers).", "nullable": true }, "deliveryProvider": { "type": "string", "description": "Provider of the delivery.", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Invoice number associated with the delivery.", "nullable": true }, "estimatedTimeOfDeparture": { "type": "string", "description": "Estimated time of departure for the delivery.", "format": "date-time", "nullable": true }, "estimatedTimeOfArrival": { "type": "string", "description": "Estimated time of arrival for the delivery.", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "Invoice date associated with the delivery.", "format": "date-time", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties associated with the delivery.", "nullable": true }, "deliveryNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of internal comments", "nullable": true }, "publicDeliveryNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of public comments", "nullable": true }, "suppliers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of suppliers", "nullable": true }, "supplierIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of supplier Ids", "nullable": true }, "deliveryStatus": { "type": "string", "description": "Status of the delivery.", "nullable": true }, "isAutoDeliveryStatusDisabled": { "type": "boolean", "description": "Disables automatic calculation of DeliveryStatus, allowing it to be set manually" }, "orderType": { "type": "string", "description": "Purchase order type (InternalTransfer or PurchaseOrder)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Delivery tags (Used for grouping / filtering deliveries)", "nullable": true } }, "additionalProperties": false, "description": "Delivery model for purchase orders" }, "OmniumDeliveryaddress": { "type": "object", "properties": { "streetName": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumDeliveryGoodsReceptionLine": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item ID", "nullable": true }, "deliveredQuantity": { "type": "number", "description": "Quantity delivered", "format": "decimal" }, "costPrice": { "type": "number", "description": "Cost price of delivery (optional)", "format": "decimal" }, "warehouseCode": { "type": "string", "description": "Warehouse code of delivery (optional)", "nullable": true }, "updateProductCostPrice": { "type": "boolean", "description": "If true, product will be updated with new cost price" }, "receiveAsUnallocated": { "type": "boolean", "description": "Only relevant when using VSL - If true then the inventory is not distributed to the virtual stock locations, resulting in unallocated inventory on the physical warehouse." }, "allocateBasedOnRules": { "type": "boolean", "description": "Only relevant when using VSL - If set then it overrides the same property on the purchase order lineItem.\r\nIf true then the inventory rule engine is used to distribute inventory over the virtual stock locations based on specified rules.\r\nIf false then the specified quantities on the virtual warehouses allocation lines are used to distribute inventory over the virtual stock locations.", "nullable": true }, "goodsReceptionId": { "type": "string", "description": "Optional. If specified, the value is stored on the InventoryTransaction.\r\nBefore processing the goods reception, the system checks for any existing InventoryTransaction with the same GoodsReceptionId.\r\nIf a match is found, processing is cancelled to prevent duplicate handling.", "nullable": true } }, "additionalProperties": false, "description": "Representing a line item for goods reception of purchase order deliveries" }, "OmniumDeliveryOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDelivery" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumDeliveryPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the delivery.", "nullable": true }, "deliveryTrackingNumber": { "type": "string", "description": "Tracking number associated with the delivery.", "nullable": true }, "deliveryTrackingLink": { "type": "string", "description": "Tracking link associated with the delivery.", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Invoice number associated with the delivery.", "nullable": true }, "estimatedTimeOfDeparture": { "type": "string", "description": "Estimated time of departure for the delivery.", "format": "date-time", "nullable": true }, "estimatedTimeOfArrival": { "type": "string", "description": "Estimated time of arrival for the delivery.", "format": "date-time", "nullable": true }, "invoiceDate": { "type": "string", "description": "Invoice date associated with the delivery.", "format": "date-time", "nullable": true }, "deliveryProvider": { "type": "string", "description": "Provider of the delivery.", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties associated with the delivery.", "nullable": true } }, "additionalProperties": false }, "OmniumDeliverySearchRequest": { "type": "object", "properties": { "createdFrom": { "type": "string", "description": "Minimum creation date to filter the search results.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Maximum creation date to filter the search results.", "format": "date-time", "nullable": true }, "estimatedTimeOfArrivalFrom": { "type": "string", "description": "Minimum expected delivery date to filter the search results.", "format": "date-time", "nullable": true }, "estimatedTimeOfArrivalTo": { "type": "string", "description": "Maximum expected delivery date to filter the search results.", "format": "date-time", "nullable": true }, "customerName": { "type": "string", "description": "Customer name to search for.", "nullable": true, "deprecated": true }, "email": { "type": "string", "description": "Email address to search for.", "nullable": true, "deprecated": true }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number to search for.", "nullable": true, "deprecated": true }, "selectedDeliveries": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected delivery ID to filter the search results.", "nullable": true }, "selectedStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected statuses to filter the search results.", "nullable": true }, "page": { "type": "integer", "description": "Page number of the search results.", "format": "int32" }, "take": { "type": "integer", "description": "Number of records to retrieve per page.", "format": "int32" }, "selectedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected store names to filter the search results.", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order of the search results.", "nullable": true }, "searchText": { "type": "string", "description": "Text to search for.", "nullable": true }, "orderType": { "type": "string", "description": "Purchase order type (InternalTransfer or PurchaseOrder)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by excluding tags", "nullable": true }, "supplierIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by supplier IDs", "nullable": true } }, "additionalProperties": false, "description": "Search model for deliveries" }, "OmniumDiscount": { "type": "object", "properties": { "discountType": { "type": "string", "description": "Specifies at what level the discount is applied.\r\nValues:\r\n- \"None\" (0): No specific type\r\n- \"LineItem\" (1): Discount applied to specific order lines. Use SkuIds to specify which products\r\n- \"Order\" (2): Discount applied to the entire order total\r\n- \"Shipping\" (3): Discount applied to shipping cost. Should be added to shipment.discounts\r\n- \"Manual\" (4): Manually applied discount (typically from UI)\r\n- \"BonusPoints\" (5): Discount paid with customer club bonus points", "nullable": true }, "skuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of SKU codes (product variant codes) that this discount applies to.\r\nRequired for LineItem discounts and for FixedPrice/MultiBuys promotions to identify which products are part of the offer.\r\nExample: [\"SKU-001\", \"SKU-002\"] for a \"Buy any 2 of these for 199\" promotion.", "nullable": true }, "discountId": { "type": "string", "description": "Unique identifier for this discount. Used to track and reference specific discount instances.", "nullable": true }, "discountAmount": { "type": "number", "description": "The calculated discount amount in the order's currency.\r\nThis is the actual monetary value that will be deducted from the order/line total.\r\nFor percentage-based discounts, this is calculated from DiscountValue.", "format": "decimal" }, "maxDiscountAmount": { "type": "number", "description": "Maximum cap for the discount amount.\r\nUseful for percentage discounts where you want to limit the maximum deduction.\r\nExample: \"20% off, maximum 100 NOK\" - set DiscountValue=20, RewardType=\"Percentage\", MaxDiscountAmount=100", "format": "decimal" }, "discountCode": { "type": "string", "description": "Coupon or promotion code that triggered this discount.\r\nUsed for tracking and for customers who enter promotional codes at checkout.", "nullable": true }, "discountName": { "type": "string", "description": "Display name for the discount, shown to customers and in reports.\r\nExample: \"Summer Sale 20%\", \"3 for 2 on selected items\", \"Free shipping\"", "nullable": true }, "discountValue": { "type": "number", "description": "The discount value used together with RewardType to calculate the actual discount.\r\n- For RewardType \"Money\": The fixed amount to deduct (e.g., 50 = 50 NOK off)\r\n- For RewardType \"Percentage\": The percentage to deduct (e.g., 20 = 20% off)\r\n- For RewardType \"Free\": Typically 100 (100% off)\r\n- For RewardType \"FixedPrice\" and \"MultiBuys\": Use the corresponding reward objects instead", "format": "decimal" }, "discountSource": { "type": "string", "description": "Indicates how the discount was created.\r\nValues: \"Manual\" (added by user/API), \"Campaign\" (from promotion engine)", "nullable": true }, "rewardType": { "type": "string", "description": "Defines how DiscountValue is interpreted and applied.\r\nValues:\r\n- \"None\" (0): No reward\r\n- \"Money\" (1): Fixed monetary discount (e.g., 50 NOK off)\r\n- \"Percentage\" (2): Percentage discount (e.g., 20% off)\r\n- \"Free\" (3): Item is free (100% off)\r\n- \"FixedPrice\" (4): Items for a fixed total price (e.g., \"4 for 99\"). Requires PromotionFixedPriceReward\r\n- \"Gift\" (5): Free gift item included\r\n- \"MultiBuys\" (6): Multi-buy offer (e.g., \"3 for 2\"). Requires PromotionMultiBuyReward\r\n- \"Kit\" (7): Set discount (buy one item from each of groups A, B, C and get discount on the set)", "nullable": true }, "priority": { "type": "integer", "description": "Priority determines the order in which discounts are applied when multiple discounts exist.\r\nLower values are applied first (0 = highest priority, applied first).\r\nImportant when combining discounts, as earlier discounts affect the base for later percentage calculations.", "format": "int32" }, "canBeCombinedWithOtherPromotions": { "type": "boolean", "description": "When true, this discount can be stacked with other promotions.\r\nWhen false, applying this discount may exclude other discounts depending on configuration." }, "alwaysApply": { "type": "boolean", "description": "When true, this discount is always applied regardless of CanBeCombinedWithOtherPromotions on other discounts.\r\nUse for discounts that should never be blocked by exclusivity rules." }, "isBonusPointsReward": { "type": "boolean", "description": "When true, the reward is given as customer club bonus points instead of a price reduction.\r\nOnly applicable for customer club promotions." }, "promotionMultiBuyReward": { "$ref": "#/components/schemas/OmniumPromotionMultiBuyReward" }, "promotionFixedPriceReward": { "$ref": "#/components/schemas/OmniumPromotionFixedPriceReward" } }, "additionalProperties": false, "description": "Represents a discount that can be applied to an order, line items, or shipping.\r\nAdd discounts to orderForm.discounts for order-level or line-item discounts,\r\nor to shipment.discounts for shipping discounts." }, "OmniumDiscountCoupon": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of this coupon", "nullable": true }, "promotionId": { "type": "string", "description": "PromotionId", "nullable": true }, "couponCode": { "type": "string", "description": "Coupon Code - Apply to cart to apply the discount", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External Ids", "nullable": true }, "validFrom": { "type": "string", "description": "Coupon valid from", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "description": "Coupon expiration date", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Discount Coupon" }, "OmniumDiscountRefund": { "type": "object", "properties": { "voucherCode": { "type": "string", "description": "Voucher or discount code used for this refund.", "nullable": true }, "amount": { "type": "number", "description": "Total discount amount (including VAT).", "format": "decimal" }, "amountNet": { "type": "number", "description": "Net discount amount (excluding VAT).", "format": "decimal" }, "amountVat": { "type": "number", "description": "VAT amount on the discount.", "format": "decimal" } }, "additionalProperties": false, "description": "Represents a discount applied to return/refund transactions." }, "OmniumDiscountSale": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total discount amount applied.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of times this discount was applied.", "format": "int32" }, "voucherCode": { "type": "string", "description": "Voucher or discount code used (optional).", "nullable": true } }, "additionalProperties": false, "description": "Represents a discount applied to sales transactions." }, "OmniumEmailAttachment": { "type": "object", "properties": { "fileName": { "type": "string", "description": "Attachment name", "nullable": true }, "contentType": { "type": "string", "description": "File type, e.g. image/jpg", "nullable": true }, "fileUrl": { "type": "string", "description": "Url pointing to blob in omnium storage containing the file to attach", "nullable": true }, "base64EncodedContent": { "type": "string", "description": "File content base64-encoded", "nullable": true } }, "additionalProperties": false, "description": "Attachment to emailmessage. There are two separate ways of using this model - Url or Base64EncodedContent.\r\n1. Url - If you your attachment is already located in omnium specify the resource url of the attachment.\r\n2. Base64EncodedContent - You can add the attachment as a Base64Encoded string. (Max length is set to 100 000)" }, "OmniumEmailMessage": { "type": "object", "properties": { "subject": { "type": "string", "description": "Email subject", "nullable": true }, "bodyText": { "type": "string", "description": "Email body text(no html)", "nullable": true }, "htmlText": { "type": "string", "description": "Email body text with", "nullable": true }, "fromAddress": { "type": "string", "description": "Email from/sender address", "nullable": true }, "fromName": { "type": "string", "description": "Email from/sender name", "nullable": true }, "referenceId": { "type": "string", "description": "Reference id for external systems like Sendgrid", "nullable": true }, "storeId": { "type": "string", "description": "Omnium store id. If email should be sendt in context of a store", "nullable": true }, "to": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of recipients email addresses", "nullable": true }, "cc": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of cc email addresses", "nullable": true }, "bcc": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of Bcc email addresses", "nullable": true }, "market": { "type": "string", "description": "If email should only be sent for a specific market(used for translation)", "nullable": true }, "attachments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEmailAttachment" }, "description": "Email attachments", "nullable": true }, "logText": { "type": "string", "description": "Text displayed in log for this event", "nullable": true } }, "additionalProperties": false, "description": "Class for sending email" }, "OmniumEmployee": { "type": "object", "properties": { "userName": { "type": "string", "description": "Omnium user name (used to connect users and employees)", "nullable": true }, "firstName": { "type": "string", "description": "Employee first name", "nullable": true }, "lastName": { "type": "string", "description": "Employee last name", "nullable": true }, "position": { "type": "string", "description": "Employee position (CEO, Customer service, Warehouse associate, etc)", "nullable": true }, "email": { "type": "string", "description": "Employee e-mail", "nullable": true }, "phone": { "type": "string", "description": "Employee phone", "nullable": true }, "imageUrl": { "type": "string", "description": "Image url", "nullable": true }, "pin": { "type": "string", "description": "[Only relevant on OmniumUserModel] Employee pin for logging into multi user", "nullable": true }, "isInactive": { "type": "boolean", "description": "[Only relevant on OmniumUserModel] Is Inactive" } }, "additionalProperties": false, "description": "Class for storing employees" }, "OmniumEntityError": { "type": "object", "properties": { "key": { "type": "string", "description": "Error type", "nullable": true }, "message": { "type": "string", "description": "Short error message", "nullable": true }, "referenceId": { "type": "string", "description": "Internal reference", "nullable": true }, "details": { "type": "string", "description": "Error details", "nullable": true }, "severity": { "type": "string", "description": "Error severity: Error, Warning, Information", "nullable": true }, "occurred": { "type": "string", "description": "Date and time the error occurred", "format": "date-time" }, "status": { "type": "string", "description": "Current status: New, Solved, Deleted", "nullable": true }, "comment": { "type": "string", "description": "Error comment", "nullable": true } }, "additionalProperties": false, "description": "Generic entity error" }, "OmniumEventDataAttachment": { "type": "object", "properties": { "value": { "type": "string", "description": "The content of the attachment (e.g. SMS text, email body)", "nullable": true }, "type": { "type": "string", "description": "The type/format of the content", "nullable": true }, "name": { "type": "string", "description": "Identifier for the attachment (e.g. \"SmsText\", \"EmailSubject\")", "nullable": true } }, "additionalProperties": false }, "OmniumEventLogCompareRequest": { "type": "object", "properties": { "searchRequest": { "$ref": "#/components/schemas/OmniumEventLogSearch" }, "previousEventSearchRequest": { "$ref": "#/components/schemas/OmniumEventLogSearch" } }, "additionalProperties": false }, "OmniumEventLogItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Event log item ID", "nullable": true }, "timestamp": { "type": "string", "description": "Timestamp for when the event occured (UTC)", "format": "date-time" }, "eventLogModel": { "$ref": "#/components/schemas/OmniumEventLogModelType" }, "eventLogType": { "$ref": "#/components/schemas/OmniumEventLogType" }, "objectId": { "type": "string", "description": "ID of the object that the event occured for", "nullable": true }, "status": { "type": "string", "description": "The status of the object", "nullable": true }, "market": { "type": "string", "description": "The market the event occured in context of", "nullable": true }, "storeId": { "type": "string", "description": "The market the event occured in context of", "nullable": true }, "userName": { "type": "string", "description": "The name of the user who triggered the event", "nullable": true }, "userId": { "type": "string", "description": "The ID of the user who triggered the event", "nullable": true }, "message": { "type": "string", "description": "SMS notification text sent to the customer. Null for non-SMS or non-notification events.", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEventDataAttachment" }, "description": "Structured attachments containing additional event data (e.g. SMS recipient phone number)", "nullable": true } }, "additionalProperties": false }, "OmniumEventLogItemOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEventLogItem" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumEventLogModelType": { "enum": [ "Order", "BusinessCustomer", "PrivateCustomer", "Project", "Product", "PriceList", "Inventory", "Store", "Cart", "User", "Delivery", "PurchaseOrder", "Supplier", "Return", "Promotion", "TenantSettings", "ScheduledTask", "Notification", "PickList", "IncompleteProduct", "EventSubscription", "Webhook" ], "type": "string", "description": "Event Log Model Types" }, "OmniumEventLogSearch": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the object", "nullable": true } }, "additionalProperties": false }, "OmniumEventLogSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items pr page", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch", "format": "int32" }, "createdFrom": { "type": "string", "description": "Events created after this time", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Events created before this time", "format": "date-time", "nullable": true }, "eventLogModel": { "$ref": "#/components/schemas/OmniumEventLogModelType" }, "eventLogType": { "$ref": "#/components/schemas/OmniumEventLogType" }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Events created in context of given stores", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Events created in context of given markets", "nullable": true }, "eventLogItemId": { "type": "string", "description": "ID of OmniumEventLogItem", "nullable": true }, "objectId": { "type": "string", "description": "ID of the object that the event occured for", "nullable": true }, "status": { "type": "string", "description": "Status of the object", "nullable": true }, "user": { "type": "string", "description": "The ID of the user who triggered the event", "nullable": true } }, "additionalProperties": false, "description": "Search request for event log items" }, "OmniumEventLogType": { "enum": [ "Created", "Added", "Deleted", "Updated", "Canceled", "Notification", "Information", "Published", "Workflow", "WorkflowStep", "Exported", "Comment", "Error" ], "type": "string", "description": "Event log type" }, "OmniumExchangeOrderOptions": { "type": "object", "properties": { "exchangeOrderId": { "type": "string", "description": "Optional: Specify the ID which the newly created exchange order will get. If not specified, Omnium will generate the ID", "nullable": true }, "exchangeOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "The order lines that will be purchased in the new exchange order - not the returned items.\r\nSo if you return item A and exchange it to item B, the ExchangeOrderLines should contain item B.", "nullable": true }, "additionalPayments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "If the exchange item(s) cost more then the original item, you must provide additional payments", "nullable": true }, "orderType": { "type": "string", "description": "Specify which order type the replacement order should be. If not provided, it will be the same type as the order that had been exchanged.\r\nThis is typically set if the original order was a click-and-collect order, but the exchange order should be a POS order.", "nullable": true }, "shippingMethodName": { "type": "string", "description": "Optional: The shipping method which should be used for the exchange order If not set, the shipping method name for the original order will be used.\r\nThis is typically set if an online order has been returned and exchange in store. You would then set this to 'PickUpInStore'", "nullable": true }, "orderStatus": { "type": "string", "description": "Order status that the exchange order should be set to (New or Completed for instance)", "nullable": true }, "outboundWarehouseCode": { "type": "string", "description": "Optional: The warehouse code to be used for the exchange order. \r\nIf not provided, it is inherited from the original order.", "nullable": true }, "storeId": { "type": "string", "description": "Optional: Explicitly sets the Store ID for the exchange order. \r\nPriority order: \r\n1. This value. \r\n2. StoreId from the Return Request. \r\n3. StoreId from the Original Order.", "nullable": true } }, "additionalProperties": false, "description": "Options for creating an exchange order from a return" }, "OmniumExcludedProductFieldOptions": { "type": "object", "properties": { "isEverythingExcluded": { "type": "boolean", "description": "Exclude all properties, except for ID. This would only be useful when used together with IncludedFields", "nullable": true }, "isVariantsExcluded": { "type": "boolean", "description": "Exclude all variant data", "nullable": true }, "isProductCategoriesExcluded": { "type": "boolean", "description": "Exclude all product categories", "nullable": true }, "isPropertiesExcluded": { "type": "boolean", "description": "Exclude all custom properties", "nullable": true }, "isPricesExcluded": { "type": "boolean", "description": "Excluded all prices", "nullable": true }, "isAssetsExcluded": { "type": "boolean", "description": "Exclude all assets (not MainImageUrl)", "nullable": true }, "isInventoryExcluded": { "type": "boolean", "description": "Exclude all inventory", "nullable": true }, "specificFields": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of specific fields to exclude. Fields should be camel cased and levels should be seperated with a dot (.), such as \"description\", \"prices.properties\" or \"variant.productCategories\"", "nullable": true } }, "additionalProperties": false, "description": "Options for excluding fields" }, "OmniumExportLogItem": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "errorReason": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "translateKey": { "type": "string", "nullable": true }, "isSuccess": { "type": "boolean" }, "errorLogged": { "type": "boolean" }, "created": { "type": "boolean" }, "timestamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "A single log entry produced during an export operation." }, "OmniumExportResult": { "type": "object", "properties": { "logItems": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExportLogItem" }, "description": "Log items describing the outcome of the export.", "nullable": true } }, "additionalProperties": false, "description": "Result of an export operation for a single entity." }, "OmniumExternalId": { "type": "object", "properties": { "providerName": { "type": "string", "description": "Provider setting the ID", "nullable": true }, "id": { "type": "string", "description": "External ID", "nullable": true } }, "additionalProperties": false, "description": "IDs from a subsystem" }, "OmniumExternalPriceResponse": { "type": "object", "properties": { "prices": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of prices to return", "nullable": true } }, "additionalProperties": false, "description": "The response to return when using an external price service" }, "OmniumFacet": { "type": "object", "properties": { "name": { "type": "string", "description": "Facet name, e.g. red, green, small, medium, etc.", "nullable": true }, "value": { "type": "string", "description": "Used for facets that required different values for filtering and displaying. Category name/ID for instance, in that case Value will contain the category ID and Name will contain the category name.", "nullable": true }, "count": { "type": "integer", "description": "Number of items with this facet", "format": "int64" } }, "additionalProperties": false, "description": "Facet" }, "OmniumFacetViewModel": { "type": "object", "properties": { "facetType": { "type": "string", "description": "Facet type (E.g. size, color, etc)", "nullable": true }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacet" }, "description": "List of facets (E.g. red, green, large, medium, etc)", "nullable": true } }, "additionalProperties": false, "description": "View model for facets" }, "OmniumFieldSelection": { "type": "object", "properties": { "include": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Only return these specific fields. Fields use camelCase with dot notation for nested fields.\r\nWhen set, only these fields (plus Id) are returned.", "nullable": true }, "exclude": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude these specific fields. Fields use camelCase with dot notation.", "nullable": true } }, "additionalProperties": false, "description": "Controls which fields are included or excluded in the response.\r\nThe Include/Exclude lists work with any entity type.\r\nEntity-specific shorthand flags can be added in derived classes." }, "OmniumFileDownloadRequest": { "required": [ "path" ], "type": "object", "properties": { "path": { "type": "string", "description": "Relative path of the file" } }, "additionalProperties": false, "description": "" }, "OmniumGetMultipleResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "The orders that were found", "nullable": true }, "missingIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of orders that were not found", "nullable": true } }, "additionalProperties": false, "description": "The response contains found orders and the IDs of orders not found (if any)." }, "OmniumGetRentalProductsBySourceRequest": { "type": "object", "properties": { "sourceProductSkuIds": { "type": "array", "items": { "type": "string" }, "description": "The source products SKU IDs to find rental products from", "nullable": true }, "storeId": { "type": "string", "description": "When set only retrieves rental products from the given store.", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "When set only retrieves rental products from the given stores. Leave empty to retrieve from all stores.", "nullable": true } }, "additionalProperties": false, "description": "Request for getting rental products from source products" }, "OmniumGetTopSellingProductsRecommendationsRequest": { "type": "object", "properties": { "since": { "type": "string", "format": "date-time" }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "includeProductData": { "type": "boolean" }, "isInStockRequired": { "type": "boolean" }, "categoryIDs": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Optional category filter. When set, top sellers are ranked by the precomputed product\r\npopularity index (sales over the popularity window, scoped to the first Omnium.Public.Recommendations.Models.OmniumGetTopSellingProductsRecommendationsRequest.MarketIds\r\nentry or global) rather than by Omnium.Public.Recommendations.Models.OmniumGetTopSellingProductsRecommendationsRequest.Since, which does not apply to category-filtered\r\nqueries. Requires the popularity index to be populated for the tenant.", "nullable": true } }, "additionalProperties": false }, "OmniumGiftCard": { "type": "object", "properties": { "id": { "type": "string", "description": "Gift card id", "nullable": true }, "balance": { "type": "number", "description": "Current balance on gift card", "format": "decimal" }, "type": { "$ref": "#/components/schemas/OmniumGiftCardType" }, "currency": { "type": "string", "description": "Gift card currency", "nullable": true }, "customerId": { "type": "string", "description": "Unique customerId", "nullable": true }, "customerName": { "type": "string", "description": "Name of customer", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer email", "nullable": true }, "giftCardCode": { "type": "string", "description": "Gift card code/number", "nullable": true }, "description": { "type": "string", "description": "Description", "nullable": true }, "isClosed": { "type": "boolean", "description": "Is gift card closed/not usable", "nullable": true }, "validUntil": { "type": "string", "description": "Gift card valid date", "format": "date-time", "nullable": true }, "closed": { "type": "string", "description": "Date for when the gift card was closed", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Last modified date", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "Gift card created date", "format": "date-time", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External ids", "nullable": true }, "marketId": { "type": "string", "description": "The market the gift card originates from.", "nullable": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumGiftCardTransaction" }, "description": "Transactions, used to show the history of the gift card.", "nullable": true } }, "additionalProperties": false, "description": "Class for Gift card payment" }, "OmniumGiftCardOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumGiftCard" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumGiftCardOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumGiftCard" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumGiftCardSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "createdFrom": { "type": "string", "description": "GiftCard created from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "GiftCard created before date", "format": "date-time", "nullable": true }, "giftCardCodes": { "type": "array", "items": { "type": "string" }, "description": "Search by multiple gift card codes.", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by gift cards created in specific markets.", "nullable": true }, "marketId": { "type": "string", "description": "Filter by gift card created in specific market.", "nullable": true, "deprecated": true }, "isExpired": { "type": "boolean", "description": "Filter by gift cards expired or not.", "nullable": true } }, "additionalProperties": false }, "OmniumGiftCardTransaction": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the transaction.", "nullable": true }, "date": { "type": "string", "description": "The time when the transaction was made.", "format": "date-time" }, "amount": { "type": "number", "description": "Amount of the transaction, in the given Currency.", "format": "decimal" }, "currency": { "type": "string", "description": "The currency of the transaction. If null, the currency is the same as for the gift card.", "nullable": true }, "description": { "type": "string", "description": "Optional explanation of the transaction.", "nullable": true }, "reference": { "type": "string", "description": "Reference to where the transaction originated from. E.g. order number og receipt number.", "nullable": true }, "storeId": { "type": "string", "description": "In which store this transaction was made.", "nullable": true }, "salesPersonId": { "type": "string", "description": "The id of the sales person who made the transaction, if originates from pos.", "nullable": true }, "amountInGiftCardCurrency": { "type": "number", "description": "The amount given in the gift card currency, in case the transaction was made in a different currency.", "format": "decimal", "nullable": true }, "exchangeRate": { "type": "number", "description": "The exchange rate used to convert the amount to the gift card currency.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Transactions on gift cards" }, "OmniumGiftCardType": { "enum": [ "GiftCard", "CreditNote" ], "type": "string" }, "OmniumIncludedFieldsOptions": { "type": "object", "properties": { "specificFields": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "The list of fields to include. Fields should be camel cased and levels should be seperated with a dot (.), so an included field could for instance be \"variants.sku\" or \"productCategories.name\"", "nullable": true } }, "additionalProperties": false, "description": "Options for including fields" }, "OmniumInheritablePropertyItem": { "type": "object", "properties": { "valueOptions": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "nullable": true }, "isCustomValueOptionAllowed": { "type": "boolean" }, "isMultiSelectEnabled": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "variantsInheritValue": { "type": "boolean" }, "siblingsInheritValue": { "type": "boolean" }, "productLanguagesInheritValue": { "type": "boolean" }, "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueType": { "type": "string", "nullable": true }, "keyGroup": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumInsightsLoyaltyMemberDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID (first entry of Customer.StoreIds).", "nullable": true }, "newMembers": { "type": "integer", "description": "New members with MemberSince on this day.", "format": "int32" } }, "additionalProperties": false, "description": "Daily new-member registrations for the Insights API.\r\nStore granularity uses the first entry of Customer.StoreIds; customers with an empty StoreIds list\r\nemit StoreId = null and are filtered out when a storeId query parameter is provided." }, "OmniumInsightsLoyaltyOrderDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID.", "nullable": true }, "memberOrders": { "type": "integer", "description": "Unique orders where Customer.IsCustomerClubMember = true at time of order.", "format": "int32" }, "memberRevenue": { "type": "number", "description": "Sum of order-line ExtendedPrice (incl. VAT) for member orders.", "format": "decimal" }, "nonMemberOrders": { "type": "integer", "description": "Unique orders where Customer.IsCustomerClubMember is false, missing, or no customer is attached (guest orders).", "format": "int32" }, "nonMemberRevenue": { "type": "number", "description": "Sum of order-line ExtendedPrice (incl. VAT) for non-member and guest orders.", "format": "decimal" } }, "additionalProperties": false, "description": "Daily order statistics split by customer-club membership for the Insights API.\r\nMember status is captured at the time the order line was indexed, not as of today.\r\nMemberOrders + NonMemberOrders equals TotalOrders from the Orders endpoint." }, "OmniumInsightsOrderDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID.", "nullable": true }, "storeName": { "type": "string", "description": "The store name at the time of aggregation.", "nullable": true }, "totalOrders": { "type": "integer", "description": "Number of unique orders for this (date, store). Counts original sales only — excludes ReturnOrder and Replacement order types.", "format": "int32" }, "clickAndCollectOrders": { "type": "integer", "description": "Number of unique orders with OrderType in {ClickAndCollect, Bopis}.", "format": "int32" }, "homeDeliveryOrders": { "type": "integer", "description": "Number of unique orders with OrderType in {Online, ShipFromStore}.", "format": "int32" }, "totalRevenue": { "type": "number", "description": "Sum of order-line ExtendedPrice (incl. VAT). Excludes shipping and order-level surcharges.", "format": "decimal" }, "totalRevenueExclVat": { "type": "number", "description": "Sum of order-line ExtendedPriceExclTax (excl. VAT). Excludes shipping and order-level surcharges.", "format": "decimal" }, "averageCartValue": { "type": "number", "description": "TotalRevenue divided by TotalOrders for this bucket.", "format": "decimal" }, "ordersByStatus": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInsightsOrderStatusCount" }, "description": "Unique order counts split by Order.Status, one entry per distinct status.", "nullable": true } }, "additionalProperties": false, "description": "Daily order statistics for the Insights API, grouped by store.\r\nOne row per (date, store) bucket with non-zero activity." }, "OmniumInsightsOrderStatusCount": { "type": "object", "properties": { "status": { "type": "string", "description": "Order.Status value in PascalCase (e.g. \"Completed\", \"Cancelled\").", "nullable": true }, "count": { "type": "integer", "description": "Number of unique orders with this status in the parent (date, store) bucket.", "format": "int32" } }, "additionalProperties": false, "description": "Order count grouped by a single Order.Status value, for use within an order insights bucket." }, "OmniumInsightsProductDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID.", "nullable": true }, "categoryId": { "type": "string", "description": "Top-level category ID (Product.MainCategoryLevel1).", "nullable": true }, "categoryName": { "type": "string", "description": "Top-level category name.", "nullable": true }, "sku": { "type": "string", "description": "The SKU identifier from the order line.", "nullable": true }, "productName": { "type": "string", "description": "Product name as captured on the order line.", "nullable": true }, "quantitySold": { "type": "number", "description": "Sum of order-line Quantity for this SKU within the bucket.", "format": "decimal" }, "revenue": { "type": "number", "description": "Sum of order-line ExtendedPrice (incl. VAT) for this SKU within the bucket.", "format": "decimal" } }, "additionalProperties": false, "description": "Daily product sales for the Insights API.\r\nOne row per (date, store, top-level category, SKU). Up to 20 SKUs are returned per category bucket, sorted by revenue." }, "OmniumInsightsProjectActivityDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The top-level Project.StoreId.", "nullable": true }, "projectTypeName": { "type": "string", "description": "The project type name.", "nullable": true }, "newProjects": { "type": "integer", "description": "Projects created on this day with Status = New.", "format": "int32" }, "completedProjects": { "type": "integer", "description": "Projects transitioning to Completed or WorkflowCompleted on this day, counted by Project.Finished.", "format": "int32" }, "cancelledProjects": { "type": "integer", "description": "Projects transitioning to any cancelled status on this day, counted by Project.Canceled.", "format": "int32" }, "estimatedValue": { "type": "number", "description": "Sum of Project.ProjectValue for new projects created on this day.", "format": "decimal" } }, "additionalProperties": false, "description": "Daily project activity for the Insights API.\r\nOne row per (date, store, project type) with at least one transition (new, completed, or cancelled) on that day." }, "OmniumInsightsProjectInProgressResponse": { "type": "object", "properties": { "storeId": { "type": "string", "description": "The top-level Project.StoreId.", "nullable": true }, "projectTypeName": { "type": "string", "description": "The project type name.", "nullable": true }, "unclarifiedProjects": { "type": "integer", "description": "Count of projects created within the requested window that currently have Status in {New, Active, OnHold}.", "format": "int32" } }, "additionalProperties": false, "description": "Current snapshot of projects in progress for the Insights API.\r\nOne row per (store, project type). This is NOT a daily series — it reflects the state at query time\r\nfor projects created within the requested [fromDate, toDate] window." }, "OmniumInsightsPromotionDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID.", "nullable": true }, "promotionId": { "type": "string", "description": "The promotion ID.", "nullable": true }, "promotionName": { "type": "string", "description": "The promotion name.", "nullable": true }, "redemptions": { "type": "integer", "description": "Number of unique orders that used this promotion on this day.", "format": "int32" }, "revenueFromPromoted": { "type": "number", "description": "Sum of order-line ExtendedPrice (incl. VAT) for lines containing this promotion.", "format": "decimal" }, "discountValue": { "type": "number", "description": "Order-level discount allocated to this promotion, summed across order lines where this is the sole promotion.\r\nComputed as the sum of (DiscountedPrice − ExtendedPrice). Lines with multiple promotions are excluded\r\nbecause the index does not store per-promotion discount amounts. Note: line-level promotion discounts\r\n(e.g., percentage-off-this-SKU) are not captured here — only the order-level portion is recoverable\r\nfrom the analytics index.", "format": "decimal" }, "discountValueCoverage": { "type": "number", "description": "Fraction of this row's Redemptions reflected in DiscountValue (single_promo_redemptions / Redemptions),\r\nin the range 0–1. A value of 1.0 means full coverage; lower values mean DiscountValue is incomplete.", "format": "decimal" } }, "additionalProperties": false, "description": "Daily promotion redemption statistics for the Insights API.\r\nOne row per (date, store, promotion). RevenueFromPromoted overlaps across promotions on multi-promotion lines —\r\nthe sum across promotions can exceed total revenue. See DiscountValue and DiscountValueCoverage for attribution caveats." }, "OmniumInsightsRequest": { "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start of the date range (inclusive), in the tenant's timezone.", "format": "date-time" }, "toDate": { "type": "string", "description": "End of the date range (inclusive), in the tenant's timezone.", "format": "date-time" }, "storeId": { "type": "string", "description": "Optional internal Omnium store ID to filter results to a single store.", "nullable": true } }, "additionalProperties": false, "description": "Common request parameters for Insights API endpoints.\r\nUsed to filter daily aggregated data by date range and optionally by store." }, "OmniumInsightsReturnDailyResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The day this row covers, formatted as yyyy-MM-dd in the tenant's timezone.", "nullable": true }, "storeId": { "type": "string", "description": "The internal Omnium store ID for the original order.", "nullable": true }, "returnCount": { "type": "integer", "description": "Number of unique returns (by ReturnOrder.ReturnOrderId) on this day.", "format": "int32" }, "returnValue": { "type": "number", "description": "Sum of pro-rated returned line value (ReturnQuantity / Quantity × ExtendedPrice), incl. VAT, absolute value.", "format": "decimal" }, "returnRate": { "type": "number", "description": "ReturnCount divided by the number of orders created on the same day. This is a simplification —\r\na return may reference an order from a different day.", "format": "decimal" } }, "additionalProperties": false, "description": "Daily return statistics for the Insights API.\r\nRows are bucketed by OrderLine.ReturnDate (when the line was returned), not by the original order date.\r\nStoreId is the original order's store, not the return warehouse." }, "OmniumInventoryAtp": { "type": "object", "properties": { "date": { "type": "string", "description": "Expected delivery date", "format": "date-time" }, "quantity": { "type": "number", "description": "Quantity delivered", "format": "decimal" }, "reservedQuantity": { "type": "number", "description": "Reserved inventory on delivery", "format": "decimal" }, "availableQuantity": { "type": "number", "description": "Quantity Available for sale", "format": "decimal", "readOnly": true }, "purchaseOrderId": { "type": "string", "description": "Purchase order ID origin of ATP value", "nullable": true }, "deliveryId": { "type": "string", "description": "Delivery ID origin of ATP value", "nullable": true }, "purchaseOrderLineId": { "type": "string", "description": "Purchase order line ID origin of ATP value", "nullable": true } }, "additionalProperties": false, "description": "Available to promise - Available quantities of the requested product, and delivery due dates." }, "OmniumInventoryAtpUpdate": { "required": [ "atp", "skuId", "warehouseCode" ], "type": "object", "properties": { "skuId": { "type": "string", "description": "Primary identifier for the inventory item, should represent the product SKU / Code / Variant / ID" }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID" }, "virtualWarehouseCode": { "type": "string", "description": "Only in use with virtual stock locations in Omnium. Specifies the virtual warehouse location of a virtual inventory item.", "nullable": true }, "atp": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtp" }, "description": "List of ATP (Available-to-Promise) entries to set on the inventory item" } }, "additionalProperties": false, "description": "Model for updating ATP (Available-to-Promise) values on an inventory item" }, "OmniumInventoryBatch": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the inventory batch.", "nullable": true }, "transactionDate": { "type": "string", "description": "The date of the transaction when this batch of inventory was purchased.", "format": "date-time" }, "modified": { "type": "string", "description": "The date when this batch was last modified.", "format": "date-time" }, "quantity": { "type": "number", "description": "The available quantity of items in the batch.", "format": "decimal" }, "costPrice": { "type": "number", "description": "The cost price per unit converted to default currency for items in this batch at the time of purchase.", "format": "decimal" }, "costValue": { "type": "number", "description": "The current total cost value of the batch, calculated as Quantity * CostPrice.", "format": "decimal", "readOnly": true }, "billingCurrency": { "type": "string", "description": "The currency used for billing when this batch was purchased.", "nullable": true }, "billingCostExchangeRate": { "type": "number", "description": "The exchange rate applied to the billing costs, representing the rate between the billing currency \r\nand the default currency configured in Omnium at the time of purchase.", "format": "decimal" }, "billingCost": { "type": "number", "description": "The cost in the billing currency for this batch at the time of purchase.", "format": "decimal" }, "currencyDate": { "type": "string", "description": "The date associated with the currency rate used for billing calculations.S", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Represents a batch of inventory in the context of the FIFO principle, \r\ncontaining specific costs and currency details that were valid at the time of purchase." }, "OmniumInventoryItem": { "type": "object", "properties": { "sku": { "type": "string", "description": "Primary identifier for the inventory item, should represent the product SKU / Code / Variant / ID", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID", "nullable": true }, "physicalWarehouseCode": { "type": "string", "description": "Only in use with virtual stock locations in Omnium. Specifies the physical warehouse location of a virtual inventory item. NB! Must be null for all physical inventories.", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Only in use with virtual stock locations in Omnium. Indicates that this is a virtual inventory item - representing a virtual allocation of physical inventory located at the PhysicalWarehouse.", "nullable": true }, "inventory": { "type": "number", "description": "Number of items in stock", "format": "decimal" }, "reservedInventory": { "type": "number", "description": "Number of reserved items", "format": "decimal" }, "calculatedInventory": { "type": "number", "description": "Calculated inventory (used for packages where available inventory is calculated from components)", "format": "decimal" }, "location": { "type": "string", "description": "Item (warehouse) location", "nullable": true }, "atp": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtp" }, "description": "List of ATP values (future deliveries)", "nullable": true }, "batches": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryBatch" }, "description": "Represents a collection of inventory batches associated with the item,\r\nordered based on the First-In, First-Out (FIFO) principle.\r\nNote: FIFO must be enabled for this property to be relevant.", "nullable": true }, "locationInventories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumLocationInventory" }, "description": "Location breakdown within the warehouse. Only populated when warehouse location management is enabled.", "nullable": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity", "format": "decimal" }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "created": { "type": "string", "description": "Created date", "format": "date-time" }, "modified": { "type": "string", "description": "Modified date", "format": "date-time" }, "reorderMinQuantity": { "type": "number", "description": "Minimum number of items to order", "format": "decimal" }, "cost": { "type": "number", "description": "The cost price per unit for this inventory item", "format": "decimal" }, "costTotal": { "type": "number", "description": "The current total cost value, calculated as Quantity * Cost.", "format": "decimal", "readOnly": true }, "costCurrency": { "type": "string", "description": "The currency of the cost price", "nullable": true } }, "additionalProperties": false, "description": "Inventory item for a specific SKU" }, "OmniumInventoryItemOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryItem" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumInventoryItemPatch": { "required": [ "skuId", "warehouseCode" ], "type": "object", "properties": { "skuId": { "type": "string", "description": "Primary identifier for the inventory item, should represent the product SKU / Code / Variant / ID. Required to identify the item to patch." }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID. Required to identify the item to patch." }, "virtualWarehouseCode": { "type": "string", "description": "Only in use with virtual stock locations in Omnium. Specifies the virtual warehouse location of a virtual inventory item.", "nullable": true }, "location": { "type": "string", "description": "Item (warehouse) location", "nullable": true }, "cost": { "type": "number", "description": "The cost price per unit for this inventory item", "format": "decimal", "nullable": true }, "costCurrency": { "type": "string", "description": "The currency of the cost price", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity", "format": "decimal", "nullable": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity", "format": "decimal", "nullable": true }, "reorderMinQuantity": { "type": "number", "description": "Minimum number of items to order", "format": "decimal", "nullable": true }, "calculatedInventory": { "type": "number", "description": "Calculated inventory (used for packages where available inventory is calculated from components)", "format": "decimal", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties (key values)", "nullable": true }, "keepExistingProperties": { "type": "boolean", "description": "Set to 'false' if you want to replace the whole 'Properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "atp": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryAtp" }, "description": "List of ATP values (future deliveries). When provided, the existing ATP list is replaced.", "nullable": true }, "fieldsToForceNull": { "type": "array", "items": { "type": "string" }, "description": "Force nullable fields to null. Use the property path, e.g. \"Location\", \"CostCurrency\", \"Properties\" or \"Atp\".", "nullable": true } }, "additionalProperties": false, "description": "Inventory item patch model for partial updates. Only the values present in the request are updated.\r\nQuantities (Inventory / ReservedInventory) are intentionally not patchable here - use the dedicated\r\ndelta (ProcessInventoryTransactions) or total (UpdateMany) endpoints for those." }, "OmniumInventoryItemUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Total number of inventory items processed", "format": "int32" }, "updatedCount": { "type": "integer", "description": "Number of inventory items updated", "format": "int32" }, "unchangedCount": { "type": "integer", "description": "Number of inventory items unchanged", "format": "int32" }, "notFoundCount": { "type": "integer", "description": "Number of inventory items not found", "format": "int32" }, "notFoundIds": { "type": "array", "items": { "type": "string" }, "description": "List of inventory item IDs that were not found", "nullable": true }, "errorCount": { "type": "integer", "description": "Number of errors encountered", "format": "int32" }, "errorMessage": { "type": "string", "description": "Error messages", "nullable": true }, "isModified": { "type": "boolean", "description": "True if any inventory item was modified" } }, "additionalProperties": false, "description": "Result of an inventory item patch operation" }, "OmniumInventorySearchRequest": { "type": "object", "properties": { "lastModified": { "type": "string", "description": "Set LastModified to a specific DateTime to get items only modified after that time", "format": "date-time", "nullable": true }, "marketId": { "type": "string", "description": "Filter inventory on market ID", "nullable": true }, "marketGroupId": { "type": "string", "description": "Filter inventory on market group ID", "nullable": true }, "productCodes": { "maxLength": 5000, "type": "array", "items": { "type": "string" }, "description": "Filter inventory on product codes (SKU / Product ID)", "nullable": true }, "warehouseCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter inventory on warehouse codes. Will be ignored if IsWebWarehouse is true", "nullable": true }, "isWebWarehouse": { "type": "boolean", "description": "If true, search will return inventory for all warehouses with IsWebWarehouse set to true. WarehouseCodes list is ignored" }, "isInStock": { "type": "boolean", "description": "If true, only inventory items with positive values are returned", "nullable": true }, "isBatchesExcluded": { "type": "boolean", "description": "Indicates whether inventory batches should be excluded in the response. \r\nThis is applicable only if the FIFO principle is activated.", "nullable": true } }, "additionalProperties": false, "description": "Contains all parameters for doing an inventory search. At least one parameter must be set" }, "OmniumInventoryTransaction": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the transaction", "nullable": true }, "variant": { "type": "string", "description": "SKU/Variant identifier", "nullable": true }, "transactionDate": { "type": "string", "description": "Date and time of the transaction", "format": "date-time" }, "warehouseCode": { "type": "string", "description": "Warehouse code where the transaction occurred", "nullable": true }, "physicalWarehouseCode": { "type": "string", "description": "Physical warehouse code (for virtual warehouses)", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Indicates if this is a virtual warehouse transaction", "nullable": true }, "relatedTransactionId": { "type": "string", "description": "Related transaction ID", "nullable": true }, "warehouseName": { "type": "string", "description": "Name of the warehouse", "nullable": true }, "inventoryChange": { "type": "number", "description": "Change in inventory quantity", "format": "decimal" }, "reservedInventoryChange": { "type": "number", "description": "Change in reserved inventory quantity", "format": "decimal" }, "newInventory": { "type": "number", "description": "New inventory quantity after transaction", "format": "decimal" }, "newReservedInventory": { "type": "number", "description": "New reserved inventory quantity after transaction", "format": "decimal" }, "orderId": { "type": "string", "description": "Associated order ID", "nullable": true }, "returnOrderId": { "type": "string", "description": "Associated return order ID", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "Associated purchase order ID", "nullable": true }, "inventoryCountItem": { "type": "string", "description": "Inventory count item identifier", "nullable": true }, "goodsReceptionId": { "type": "string", "description": "Goods reception ID", "nullable": true }, "userId": { "type": "string", "description": "User ID who performed the transaction", "nullable": true }, "userName": { "type": "string", "description": "User name who performed the transaction", "nullable": true }, "reason": { "type": "string", "description": "Reason for the transaction", "nullable": true }, "location": { "type": "string", "description": "Storage location", "nullable": true }, "batchIndex": { "type": "string", "description": "Batch index", "nullable": true }, "inventoryChangeValue": { "type": "number", "description": "Value of the inventory change", "format": "decimal" }, "totalInventoryValue": { "type": "number", "description": "Total inventory value after transaction", "format": "decimal" }, "transactionType": { "type": "string", "description": "Type of transaction", "nullable": true }, "internalReference": { "type": "string", "description": "Internal reference", "nullable": true }, "toLocation": { "type": "string", "description": "Destination location for location transfer transactions", "nullable": true } }, "additionalProperties": false, "description": "Represents an inventory transaction in the public API" }, "OmniumInventoryTransactionOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInventoryTransaction" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumInventoryTransactionSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to take (page size)", "format": "int32" }, "page": { "type": "integer", "description": "Page number (starts from 1)", "format": "int32" }, "productId": { "type": "string", "description": "Filter by product ID", "nullable": true }, "skuId": { "type": "string", "description": "Filter by SKU ID", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "Filter by purchase order ID", "nullable": true }, "userId": { "type": "string", "description": "Filter by user ID", "nullable": true }, "orderId": { "type": "string", "description": "Filter by order ID", "nullable": true }, "warehouseCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by warehouse codes", "nullable": true }, "searchText": { "type": "string", "description": "Search text for general search", "nullable": true }, "from": { "type": "string", "description": "Start date for transaction date range", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "End date for transaction date range", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Contains all parameters for doing an inventory transaction search" }, "OmniumInventoryUpdate": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Primary identifier for the inventory item, should represent the product SKU / Code / Variant / ID", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID", "nullable": true }, "virtualWarehouseCode": { "type": "string", "description": "Only in use with virtual stock locations in Omnium. Specifies the virtual warehouse location of a virtual inventory item and will cause a reduction in both physical and virtual inventory levels for the sku. NB! Must be null for all physical inventories.", "nullable": true }, "inventoryChange": { "type": "number", "description": "The change in inventory level", "format": "decimal" }, "adjustReservedInventory": { "type": "boolean", "description": "If true both the inventory and reserved inventory level will be updated with the specified change." }, "orderId": { "type": "string", "description": "The order Id of the order related with the change.", "nullable": true }, "reason": { "type": "string", "description": "[Optional] Reason for inventory change", "nullable": true }, "locationCode": { "type": "string", "description": "[Optional] Location code within the warehouse. When provided and warehouse location management\r\nis enabled, the inventory change is applied to both the warehouse total and the specified location.\r\nWhen null, only the warehouse total is updated.", "nullable": true } }, "additionalProperties": false, "description": "Model for modifying an inventory item in Omnium" }, "OmniumInvoice": { "type": "object", "properties": { "id": { "type": "string", "description": "Invoice ID", "nullable": true }, "url": { "type": "string", "description": "Invoice URL (invoice PDF or other external url)", "nullable": true }, "invoiceNumber": { "type": "string", "description": "Invoice number", "nullable": true }, "invoiceType": { "type": "string", "description": "Invoice type [Ingoing, Outgoing, ]", "nullable": true }, "invoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "customerId": { "type": "string", "description": "Customer ID", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer email", "nullable": true }, "customerType": { "type": "string", "description": "Customer type (Business / Private)", "nullable": true }, "invoiceDueDate": { "type": "string", "description": "Invoice due date", "format": "date-time" }, "kid": { "type": "string", "description": "Invoice KID-number (Norwegian customer identification number)", "nullable": true }, "comment": { "type": "string", "description": "Invoice comment", "nullable": true }, "orderId": { "type": "string", "description": "Original order Id", "nullable": true }, "projectId": { "type": "string", "description": "Id of related project", "nullable": true }, "deliveryDate": { "type": "string", "description": "Deliver date", "format": "date-time" }, "amount": { "type": "number", "description": "In the order currency, typically USD, SEK, NOK.", "format": "decimal" }, "amountExcludingTax": { "type": "number", "description": "Amount excluding tax", "format": "decimal" }, "amountRoundoff": { "type": "number", "description": "Amount of round off to nearest integer", "format": "decimal" }, "amountOutstanding": { "type": "number", "description": "The amount outstanding", "format": "decimal" }, "currency": { "type": "string", "description": "Invoice currency", "nullable": true }, "isCreditNote": { "type": "boolean", "description": "True if invoice is a credit note" }, "origin": { "type": "string", "description": "Where the invoice originated (Which system provided the ID)", "nullable": true }, "storeId": { "type": "string", "description": "Invoice store ID", "nullable": true }, "marketId": { "type": "string", "description": "Invoice market ID", "nullable": true }, "modified": { "type": "string", "description": "Modified date", "format": "date-time" }, "created": { "type": "string", "description": "Created date", "format": "date-time" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External IDs", "nullable": true }, "paymentMethodName": { "type": "string", "description": "Payment method", "nullable": true, "deprecated": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Assets", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "Invoiced order lines", "nullable": true }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "All order payments", "nullable": true }, "invoiceSenderAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "customerAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "deliveryAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" } }, "additionalProperties": false, "description": "Invoices" }, "OmniumInvoiceOmniumInvoiceTotalsOmniumSearchResultWithTotals": { "type": "object", "properties": { "totals": { "$ref": "#/components/schemas/OmniumInvoiceTotals" }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInvoice" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets and totals" }, "OmniumInvoiceOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumInvoice" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumInvoiceSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Paged search - max number of invoices to return", "format": "int32" }, "page": { "type": "integer", "description": "Paged search - page", "format": "int32" }, "invoiceId": { "type": "string", "description": "Search Invoices by Id", "nullable": true }, "invoiceTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search Invoices by invoice types", "nullable": true }, "email": { "type": "string", "description": "Search Invoices by Email", "nullable": true }, "phone": { "type": "string", "description": "Search Invoices by Phone", "nullable": true }, "customerName": { "type": "string", "description": "Search Invoices by CustomerName", "nullable": true }, "customerId": { "type": "string", "description": "Search Invoices by CustomerId", "nullable": true }, "orderId": { "type": "string", "description": "Search Invoices by OrderId", "nullable": true }, "projectId": { "type": "string", "description": "Search Invoices by ProjectId", "nullable": true }, "query": { "type": "string", "description": "Free text search Invoices (search applies to fields Id, OrderId, ProjectId, CustomerName, CustomerId, InvoiceNumber, Kid and ExternalIds)", "nullable": true }, "isPaid": { "type": "boolean", "description": "Search Invoices by payment statust", "nullable": true }, "createdFrom": { "type": "string", "description": "Search Invoices by CreatedDate", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Search Invoices by CreatedDate", "format": "date-time", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Search Invoices by property values and or keys (match all)", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort result. Available options [CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, InvoiceDueDateAscending, InvoiceDueDateDescending]", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Limit search by market IDs", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Limit search by store IDs", "nullable": true }, "includeTotals": { "type": "boolean", "description": "Include the `totals` field in the response" } }, "additionalProperties": false }, "OmniumInvoiceTotals": { "type": "object", "properties": { "totalAmountSum": { "type": "number", "format": "double", "nullable": true }, "totalAmountExcludingVatSum": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Response model for" }, "OmniumLineItemPropertiesPatch": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "id to update", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Properties to update", "nullable": true } }, "additionalProperties": false, "description": "Used for patch update properties on a orderline" }, "OmniumLineItemRequestModel": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Sku id of product to add to cart", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of product to add to cart. If null and selectedUnitQty is given, this will be updated to selectedUnitQty * conversionFactor. (defaults to 1)", "format": "decimal", "nullable": true }, "unit": { "type": "string", "description": "Quantity unit - e.g. Meter,Pcs,Litre, etc", "nullable": true }, "selectedUnit": { "type": "string", "description": "The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)", "nullable": true }, "selectedUnitConversionFactor": { "type": "number", "description": "Conversion factor from default unit to selected unit", "format": "decimal", "nullable": true }, "selectedUnitQuantity": { "type": "number", "description": "The quantity ordered in the selected unit of measurement.", "format": "decimal", "nullable": true }, "priceStoreId": { "type": "string", "description": "Only use when buying from a store with a higher unit price than the default price", "nullable": true } }, "additionalProperties": false, "description": "Model for adding many line items to cart" }, "OmniumLineItemReturn": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "ID of line item to return", "nullable": true }, "returnQuantity": { "type": "number", "description": "Quantity returned", "format": "decimal" }, "returnReason": { "type": "string", "description": "Return reason. Free text.", "nullable": true }, "returnType": { "type": "string", "description": "Return type ID", "nullable": true }, "isStockUpdated": { "type": "boolean", "description": "Whether the return order line should update stock (inventory) value.\r\nIf set to 'true', the stock would increase with the same amount as the quantity on the return order line.\r\nIf set to 'false', the stock would be unaffected.\r\nIf set to null, return settings will decide.", "nullable": true }, "creditAmount": { "type": "number", "description": "Amount to credit on a returnItem pr item. Total orderLine credit amount will be creditAmount * quantity. If not specified, the item will be fully credited. Type: Decimal.", "format": "decimal", "nullable": true }, "internalWarehouseLocation": { "type": "string", "description": "Use this to specify location within the warehouse. In case you have separate locations for returned products IE. Broken/UsedOrOpened/SellAsNew\r\n**Not required**", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties to set on the return order line", "nullable": true } }, "additionalProperties": false, "description": "Request object for adding return line items" }, "OmniumLineItemUpdate": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "LineItem / Order line ID", "nullable": true }, "deliveredQuantity": { "type": "number", "description": "Delivered quantity", "format": "decimal" }, "canceledQuantity": { "type": "number", "description": "Cancelled quantity", "format": "decimal" }, "splitQuantity": { "type": "number", "description": "Used when you only want to split shipment and not deliver", "format": "decimal" }, "readyForPickupQuantity": { "type": "number", "format": "decimal" }, "reallocateQuantity": { "type": "number", "description": "Reallocate quantity (Will try to reallocate the quantity to other warehouse if possible)", "format": "decimal" }, "cost": { "type": "number", "description": "Cost price", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Request model for updating line items" }, "OmniumLineItemUpdateRequest": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Sku id of product to add to cart", "nullable": true }, "quantity": { "type": "number", "description": "Quantity to add. Defaults to 1 if not provided. If unitId is specified then this refers to the units quantity.", "format": "decimal", "nullable": true }, "unitId": { "type": "string", "description": "EAN for product unit - If set then the quantity will refer to the unit's quantity. If no matching unit price is found we will fallback to default unit and price", "nullable": true }, "priceStoreId": { "type": "string", "description": "Only use when buying from a store with a higher unit price than the default price", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties that will be added to the order line", "nullable": true }, "forceNewOrderLine": { "type": "boolean", "description": "If set to true, a new order line will be created even if there is an existing order line with the same sku" } }, "additionalProperties": false, "description": "Model for adding many line items to cart" }, "OmniumLocationInventory": { "type": "object", "properties": { "locationCode": { "type": "string", "description": "Location code within the warehouse (e.g., \"A-01-3\")", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of items at this location", "format": "decimal" }, "isDefaultLocation": { "type": "boolean", "description": "Whether this is the default location for the SKU in this warehouse" } }, "additionalProperties": false, "description": "Represents inventory at a specific location within a warehouse" }, "OmniumLocationTransferRequest": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Product SKU / Code / Variant / ID", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID", "nullable": true }, "fromLocationCode": { "type": "string", "description": "Source location code. Null to assign from unlocated stock.", "nullable": true }, "toLocationCode": { "type": "string", "description": "Destination location code", "nullable": true }, "quantity": { "type": "number", "description": "Quantity to transfer", "format": "decimal" }, "setAsDefault": { "type": "boolean", "description": "If true, set the destination as the default location for this SKU" } }, "additionalProperties": false, "description": "Request model for transferring inventory between locations within a warehouse, or assigning unlocated stock to a location" }, "OmniumMarket": { "type": "object", "properties": { "marketId": { "type": "string", "description": "Unique market ID (ENG, NOR, SWE, etc)", "nullable": true }, "marketName": { "type": "string", "description": "Name of market", "nullable": true }, "isDefaultMarket": { "type": "boolean", "description": "True if market should be used by default for new orders", "nullable": true }, "isActive": { "type": "boolean", "description": "True if market is active. False if temporary unavailable.", "nullable": true }, "isTaxExcluded": { "type": "boolean", "description": "True if tax should not be added to orders", "nullable": true }, "language": { "type": "string", "description": "Market language name (English, Norwegian, German, etc...)", "nullable": true }, "languageCode": { "type": "string", "description": "Market language code (two letter ISO: no, en, etc...)", "nullable": true }, "isoLanguageCode": { "type": "string", "description": "ISO Language/Region-code (en-US, nb-NO, de-DE, etc...)", "nullable": true }, "countryCode": { "type": "string", "description": "Two letter country code (\"EN\", \"NO\", etc...)", "nullable": true }, "currency": { "type": "string", "description": "Default market currency (USD, EUR, NOK etc)", "nullable": true }, "productContentLanguage": { "type": "string", "description": "Default market content language for products (en, se, no, etc)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Used for CompanyId in D365, but can also be used as a key to group multiple markets", "nullable": true }, "marketGroupLabel": { "type": "string", "description": "Used for labeling market groups in UI", "nullable": true }, "marketType": { "type": "string", "description": "B2C / B2B / Possible other values for other tenants", "nullable": true }, "defaultTaxRate": { "type": "number", "description": "Default tax rate for market", "format": "decimal", "nullable": true }, "defaultStoreId": { "type": "string", "description": "If set, this store is used as default store on new carts for this market.\r\nPrioritized over the customer's stores and the default warehouse, but not over the user's own store context.", "nullable": true }, "websiteUrl": { "type": "string", "description": "Public website url", "nullable": true }, "documentFooter": { "type": "string", "description": "Footer in documents like order receipt pdf.\r\nUsed as fallback if store does not have value in DocumentFooter prop", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "shipmentOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentOption" }, "description": "List of shipment options available for market", "nullable": true } }, "additionalProperties": false, "description": "Market" }, "OmniumMarketGroup": { "type": "object", "properties": { "groupId": { "type": "string", "description": "Unique market group ID", "nullable": true }, "groupName": { "type": "string", "description": "Name of market group", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of markets belonging to this group", "nullable": true } }, "additionalProperties": false, "description": "Market group" }, "OmniumMergePurchaseOrderRequest": { "type": "object", "properties": { "destinationPurchaseOrderId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumOmniStockLevel": { "type": "object", "properties": { "storeId": { "type": "string", "description": "Store ID", "nullable": true }, "stockLevel": { "type": "string", "description": "Stock level for the store. Possible values: 'HighInStock', 'LowInStock', 'OutOfStock'.", "nullable": true } }, "additionalProperties": false, "description": "Calculated stock level for a product in a specific store, used for online availability." }, "OmniumOpeninghour": { "type": "object", "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "day": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumOpeningHours": { "type": "object", "properties": { "isOpen": { "type": "boolean", "description": "False if closed entire day, true if open this day" }, "openFrom": { "type": "string", "description": "Closed stores should be set to 00:00:00 (TimeSpan.Zero)", "example": "00:00:00" }, "openTo": { "type": "string", "description": "Closed stores should be set to 00:00:00 (TimeSpan.Zero)", "example": "00:00:00" } }, "additionalProperties": false, "description": "Class for storing store opening hours" }, "OmniumOpeningHoursPatch": { "type": "object", "properties": { "isOpen": { "type": "boolean", "description": "False if closed entire day, true if open this day", "nullable": true }, "openFrom": { "type": "string", "description": "Closed stores should be set to 00:00:00 (TimeSpan.Zero)", "nullable": true, "example": "00:00:00" }, "openTo": { "type": "string", "description": "Closed stores should be set to 00:00:00 (TimeSpan.Zero)", "nullable": true, "example": "00:00:00" } }, "additionalProperties": false, "description": "Class for storing store opening hours" }, "OmniumOrder": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique order ID. This must and will be unique across all markets defined in Omnium.", "nullable": true }, "orderNumber": { "type": "string", "description": "In most cases, this property will be identical to the Id property.\r\nHowever, if you have orders from multiple sources (multiple e-commerce sites, pos systems or other sales channels),\r\nand the order numbers from the sources could overlap, you could set the Id to a unique value and the order number to the user friendly number.", "nullable": true }, "customerId": { "type": "string", "description": "The ID of the customer that has placed the order. Typically this is set to the customers phone number or email address, but it could be set to anything.\r\nA customer with the matching ID does not have to exist in the system before the order is placed.\r\nIf there are no overlapping IDs, but you still have multiple sources of IDs, consider using ExternalIds instead.", "nullable": true }, "customerNumber": { "type": "string", "description": "In most cases, the customer number could be set to the same value as the CustomerId.\r\nHowever, in some edge cases the customers could get imported from multiple systems with the same ID range. In that case,\r\nyou should set the user friendly number to the CustomerNumber and an unique ID for the CustomerId.", "nullable": true }, "customerClubMemberId": { "type": "string", "description": "If Customer is member of customer club, set Customer ID as member ID.", "nullable": true }, "billingCurrency": { "type": "string", "description": "Currency of the order. e.g. \"USD\",\"NOK\"", "nullable": true }, "customerName": { "type": "string", "description": "Full name of customer", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone number with prefix. e.g. +4740000000", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "customerType": { "type": "string", "description": "B2B or B2C (Business customer or private customer)", "nullable": true }, "marketId": { "type": "string", "description": "Market ID e.g. \"US\", \"NOR\", \"SWE\". This must match the value of the market(s) defined in Omnium.", "nullable": true }, "billingAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "orderForm": { "$ref": "#/components/schemas/OmniumOrderForm" }, "orderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, for internal use / not for customer", "nullable": true }, "publicOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, visible for customer", "nullable": true }, "shippingDiscountTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Shipping discount amount", "format": "decimal", "deprecated": true }, "shippingSubTotal": { "type": "number", "description": "Total shipping cost", "format": "decimal", "deprecated": true }, "status": { "type": "string", "description": "The current order status. This must match a status defined in the order settings in Omnium.\r\nTypical values are \"New\", \"InProgress\", \"Cancelled\" or \"Completed\".", "nullable": true }, "remainingPayment": { "type": "number", "description": "CALCULATED: The remaining payment amount if the difference between the authorized amount and total amount", "format": "decimal" }, "salesPersonId": { "type": "string", "description": "Id of seller of the order - typically set to the e-mail of the user in Omnium, but could be set to any ID.", "nullable": true }, "salesPersonName": { "type": "string", "description": "Name of the seller of the order", "nullable": true }, "salesChannel": { "type": "string", "description": "Name of sales channel", "nullable": true }, "completed": { "type": "string", "description": "CALCULATED: Order completed date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "CALCULATED: Order last modified date", "format": "date-time" }, "modifiedBy": { "type": "string", "description": "CALCULATED: Modified by", "nullable": true }, "created": { "type": "string", "description": "The creation date of the order", "format": "date-time" }, "received": { "type": "string", "description": "The received date of the order", "format": "date-time", "nullable": true }, "followUpDate": { "type": "string", "description": "Order follow-up date", "format": "date-time", "nullable": true }, "customerPickupDeadline": { "type": "string", "description": "CALCULATED: Customer deadline for picking up order", "format": "date-time", "nullable": true }, "storePickDate": { "type": "string", "description": "CALCULATED: Employee deadline for picking order", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Delivery date requested by customer", "format": "date-time", "nullable": true }, "updateStatusDate": { "type": "string", "description": "Date when order should be moved to next status. (Updated by UpdateOrderStatusScheduledTask)", "format": "date-time", "nullable": true }, "readyForPickup": { "type": "string", "description": "Calculated: When the order was set to ready for pickup. The property can be set by workflow step with name: Set ready for pickup date", "format": "date-time", "nullable": true }, "nextOrderStatus": { "type": "string", "description": "Status order should be moved to. (Updated by UpdateOrderStatusScheduledTask)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "paymentType": { "type": "string", "description": "OBSOLETE: Use orderForm.payments instead.", "nullable": true, "deprecated": true }, "orderType": { "type": "string", "description": "Order type e.g. \"Online\", \"Pos\". The order type must match a order type defined in the Omnium order settings", "nullable": true }, "storeId": { "type": "string", "description": "The store Id identifies the store that sells the orders. Should match an ID of an existing store.\r\nA store would typically be the front end e-commerce solution, a physical store or other sales channels.", "nullable": true }, "returnOrderForms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderForm" }, "description": "The returns for the current order. An order could have one or multiple return order forms.", "nullable": true }, "orderOrigin": { "type": "string", "description": "The origin of the order should identify where the order was created. Typical values are \"OMS\", \"ERP\", \"WEB\" or \"POS\".", "nullable": true }, "lineItemsCost": { "type": "number", "description": "Calculated: Total cost of the order. The cost price", "format": "decimal" }, "netTotal": { "type": "number", "description": "Calculated: OrderForm total - returnForms total", "format": "decimal" }, "netTotalExclTax": { "type": "number", "description": "Calculated: OrderForm total excl tax - returnForms total excl tax", "format": "decimal" }, "customerReference": { "type": "string", "description": "Reference provided by customer.", "nullable": true }, "customerContact": { "type": "string", "description": "Customer contact person", "nullable": true, "deprecated": true }, "customerRequisition": { "type": "string", "description": "Customer requisition provided by customer", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/OmniumContactPerson" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external IDs. External IDs are visible in Omnium's UI and useful for display, searching and filtering on IDs originating from other systems.\r\nA typical use case could be to add the IDs from ERP/POS/E-COM systems that does not match the order ID in order to simplify integration and traceability", "nullable": true }, "isReadOnly": { "type": "boolean", "description": "If true, the order is not editable in Omnium. Typically used for completed PoS orders, historic data or orders that should never be modified." }, "isNotificationsDisabled": { "type": "boolean", "description": "If true, Omnium's notifications will not be triggered for the order" }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the current order.", "nullable": true }, "relatedOrders": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of related order IDs", "nullable": true }, "session": { "type": "string", "description": "Session code used for referencing a web session", "nullable": true }, "secretKey": { "type": "string", "description": "A unique secret key for the order. Can be used for secure order lookups.", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Order assets (documents, media, files)", "nullable": true }, "replacementOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of replacement order IDs for this order", "nullable": true }, "subscriptionId": { "type": "string", "description": "Subscription ID - used if order is part of a subscription. The Id should match an existing subscription in Omnium", "nullable": true }, "projectIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Project IDs - used if order is part of projects", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Order tags (Used by notification filters, and for grouping / filtering orders)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (in days). Used for invoice due dates.", "format": "int32", "nullable": true }, "invoiceComment": { "type": "string", "description": "Invoice comment", "nullable": true }, "projectId": { "type": "string", "description": "OBSOLETE: Use ProjectIds instead. Project ID - used if order is part of a project", "nullable": true, "deprecated": true }, "subTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost", "format": "decimal", "deprecated": true }, "subTotalExclTax": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total without shipment cost and without tax", "format": "decimal", "deprecated": true }, "taxTotal": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Total tax amount", "format": "decimal", "deprecated": true }, "total": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost, tax, and discounts", "format": "decimal", "deprecated": true }, "totalExclTax": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Order total, including shipment cost and discounts, but without tax", "format": "decimal", "deprecated": true }, "discountTotalIncVat": { "type": "number", "description": "(OBSOLETE: Use property on OrderForm instead) Total order discount", "format": "decimal", "deprecated": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderGroup" }, "description": "Order line groups", "nullable": true }, "isNewCustomer": { "type": "boolean", "description": "Indicates whether the customer is new. Set automatically by the workflow if the customer's creation date is in the past, \r\nbut can also be updated via the API.", "nullable": true }, "versionId": { "type": "string", "description": "Read only: Current version ID", "nullable": true }, "name": { "type": "string", "description": "Order name", "nullable": true }, "canceled": { "type": "string", "description": "Canceled date", "format": "date-time", "nullable": true }, "orgNr": { "type": "string", "description": "Organization number", "nullable": true }, "correlationId": { "type": "string", "description": "Correlation ID for tracing", "nullable": true }, "isAnonymized": { "type": "boolean", "description": "Whether the order has been anonymized" }, "isReservable": { "type": "boolean", "description": "Whether the order is reservable", "nullable": true }, "pendingNotificationIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPendingNotification" }, "description": "Pending notifications that should be picked up by the notification scheduler.\r\nWhen the notification has been sent, the notification ID will be removed from the list.", "nullable": true }, "invoiceIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of invoice IDs associated with this order", "nullable": true }, "documentStatus": { "type": "string", "description": "Shows which documents have been generated for the order", "nullable": true }, "customerOrderNumber": { "type": "string", "description": "Customer's own order number", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer group memberships", "nullable": true }, "isReallocated": { "type": "boolean", "description": "Whether the order has been reallocated" } }, "additionalProperties": false, "description": "Omnium order object" }, "OmniumOrderActionExecutionResult": { "type": "object", "properties": { "actionStatus": { "type": "string", "description": "\"Success\", \"Warning or \"Error\".", "nullable": true }, "errorReason": { "type": "string", "description": "Error description", "nullable": true }, "translateKey": { "type": "string", "description": "Translation key for result description", "nullable": true }, "actionType": { "type": "string", "description": "Order action type (e.g. \"Notification\", \"CapturePayment\", \"ReduceInventory\", etc)", "nullable": true }, "cancelWorkflow": { "type": "boolean", "description": "Is this step cancelling further workflow execution" }, "isInvisible": { "type": "boolean", "description": "True if workflow step and result should be hidden for end user" } }, "additionalProperties": false, "description": "Result from single workflow action" }, "OmniumOrderAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "Address name (Organization address name for B2B / FirstName + LastName for B2C)", "nullable": true }, "firstName": { "type": "string", "description": "Recipient first name", "nullable": true }, "lastName": { "type": "string", "description": "Recipient last name", "nullable": true }, "organization": { "type": "string", "description": "Organization name", "nullable": true }, "organizationalNumber": { "type": "string", "description": "Organization number (e.g. VAT number, company registration number)", "nullable": true }, "line1": { "type": "string", "description": "Address line 1", "nullable": true }, "line2": { "type": "string", "description": "Address line 2", "nullable": true }, "streetNumber": { "type": "string", "description": "Street / House number - if not included in Line 1. See Customer settings", "nullable": true }, "apartmentNumber": { "type": "string", "description": "Apartment number e.g. \"0402\"", "nullable": true }, "city": { "type": "string", "description": "City name", "nullable": true }, "state": { "type": "string", "description": "State e.g. \"Arizona\", \"California\" etc.", "nullable": true }, "countryCode": { "type": "string", "description": "Country code for shipment e.g. \"SE\", \"DK\"", "nullable": true }, "countryName": { "type": "string", "description": "Country name, e.g. \"USA\", \"Norway\" ...", "nullable": true }, "postalCode": { "type": "string", "description": "Postal / ZIP code", "nullable": true }, "regionCode": { "type": "string", "description": "Region code for shipping", "nullable": true }, "regionName": { "type": "string", "description": "Region name e.g. \"Buskerud\"", "nullable": true }, "daytimePhoneNumber": { "type": "string", "description": "Contact phone number", "nullable": true }, "eveningPhoneNumber": { "type": "string", "description": "Contact phone number at evening", "nullable": true }, "phone": { "type": "string", "description": "Contact phone number", "nullable": true }, "email": { "type": "string", "description": "Contact email", "nullable": true }, "externalId": { "type": "string", "description": "If address has id from other external system", "nullable": true } }, "additionalProperties": false, "description": "Order address" }, "OmniumOrderCommentRequest": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID", "nullable": true }, "commentType": { "$ref": "#/components/schemas/OmniumCommentType" }, "commentText": { "type": "string", "description": "The comment text/message content", "nullable": true }, "createdBy": { "type": "string", "description": "The sender/creator of the comment (e.g., external user, system or sales channel).\r\nDefaults to the current's API user's username", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/filtering comments", "nullable": true }, "marketId": { "type": "string", "description": "Market ID (optional, uses order's market if not specified)", "nullable": true }, "sendEmail": { "type": "boolean", "description": "Send email notification to customer" }, "emailSubject": { "type": "string", "description": "Email subject line", "nullable": true }, "emailTo": { "type": "string", "description": "Email recipient address. Falls back to order's customer email if not specified.", "nullable": true }, "emailCc": { "type": "string", "description": "Email CC recipients (semicolon separated)", "nullable": true }, "emailBcc": { "type": "string", "description": "Email BCC recipients (semicolon separated)", "nullable": true }, "emailFrom": { "type": "string", "description": "Email from address. Falls back to store's default email if not specified.", "nullable": true }, "senderName": { "type": "string", "description": "Sender display name for email and SMS notifications. Falls back to store's default sender name if not specified.", "nullable": true }, "sendSms": { "type": "boolean", "description": "Send SMS notification to customer" }, "smsPhoneNumber": { "type": "string", "description": "Phone number for SMS. Falls back to order's customer phone if not specified.", "nullable": true } }, "additionalProperties": false, "description": "Request model for adding a comment to an order" }, "OmniumOrderExportModel": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/OmniumOrder" }, "shipment": { "$ref": "#/components/schemas/OmniumShipment" }, "returnOrderForm": { "$ref": "#/components/schemas/OmniumReturnOrderForm" } }, "additionalProperties": false, "description": "Used for webhooks and export" }, "OmniumOrderExportRequest": { "required": [ "orderIds" ], "type": "object", "properties": { "connectorId": { "type": "string", "description": "The connector ID to export orders to, for example \"f60203b3-82fa-4f5c-8578-7777d4faf5e4\", \"19527b9b-6ebf-4d34-8e32-28ff618ff168\"", "nullable": true }, "connectorName": { "type": "string", "description": "Exporter name, the name of the exporter for example \"inretrn\", \"sitoo\"", "nullable": true }, "orderIds": { "minLength": 1, "type": "array", "items": { "type": "string" }, "description": "List of order IDs to export" } }, "additionalProperties": false, "description": "Request model for exporting orders to a connector" }, "OmniumOrderForm": { "type": "object", "properties": { "shipments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "All order shipments", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "All order lines / products", "nullable": true }, "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "All discounts", "nullable": true }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "All order payments", "nullable": true }, "shippingDiscountTotal": { "type": "number", "description": "Calculated:Total shipping discounts", "format": "decimal" }, "shippingSubTotal": { "type": "number", "description": "Calculated: Shipping cost without discounts", "format": "decimal" }, "shippingSubTotalExclTax": { "type": "number", "description": "Calculated: shipping cost without discounts excl tax", "format": "decimal" }, "shippingCreditedTotal": { "type": "number", "description": "Calculated: Total shipping cost credited", "format": "decimal" }, "cartName": { "type": "string", "description": "Name of cart / offer, such as \"A special offer for a special customer\".\r\nThis is typically used in scenarios where a customer is presented with an offer (in form of a cart).", "nullable": true }, "cartId": { "type": "string", "description": "Unique ID of cart", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "Purchase order ID (if order was created from a purchase order)", "nullable": true }, "couponCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of CouponCodes added by user", "nullable": true }, "shippingTotal": { "type": "number", "description": "Calculated: Total shipping cost.", "format": "decimal", "readOnly": true }, "handlingTotal": { "type": "number", "description": "Cost of handling", "format": "decimal" }, "orderLevelTax": { "type": "number", "description": "Order level tax amount", "format": "decimal" }, "taxTotal": { "type": "number", "description": "Calculated: Total tax amount (line item level and order level)", "format": "decimal" }, "discountAmount": { "type": "number", "description": "Calculated: Total discount amount", "format": "decimal" }, "subTotal": { "type": "number", "description": "Calculated: Order total without shipment cost", "format": "decimal" }, "subTotalExclTax": { "type": "number", "description": "Calculated: Order total without shipment cost and without tax", "format": "decimal" }, "total": { "type": "number", "description": "Calculated: Order total, including shipment cost, tax, and discounts", "format": "decimal" }, "totalExclTax": { "type": "number", "description": "Calculated: Order total, including shipment cost and discounts, but without tax", "format": "decimal" }, "authorizedPaymentTotal": { "type": "number", "description": "Total amount authorized by payment providers", "format": "decimal" }, "capturedPaymentTotal": { "type": "number", "description": "Total amount captured by payment providers", "format": "decimal" }, "creditPaymentTotal": { "type": "number", "description": "Total amount credited by payment providers", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "charges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCharge" }, "description": "Obsolete: Add order lines instead. A list of additional charges for the order", "nullable": true, "deprecated": true }, "fullRefund": { "type": "boolean", "description": "True if order should be fully refunded" }, "isPriority": { "type": "boolean", "description": "Possible to mark the order with priority", "nullable": true }, "grossRoundoff": { "type": "number", "description": "Set by external systems. Is added to orderform.total.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Order form, containing shipments, payments and line items for order" }, "OmniumOrderFormPatch": { "type": "object", "properties": { "shipments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "All order shipments", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "All order lines / products", "nullable": true }, "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "All discounts", "nullable": true }, "discountsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentPatch" }, "description": "All order payments", "nullable": true }, "paymentsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shipmentsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shippingDiscountTotal": { "type": "number", "description": "Total shipping discounts", "format": "decimal", "nullable": true }, "shippingSubTotal": { "type": "number", "description": "Shipping cost without discounts", "format": "decimal", "nullable": true }, "shippingSubTotalExclTax": { "type": "number", "description": "shipping cost without discounts excl tax", "format": "decimal", "nullable": true }, "cartName": { "type": "string", "description": "Name of cart / offer", "nullable": true }, "cartId": { "type": "string", "description": "ID of original cart", "nullable": true }, "couponCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of CouponCodes added by user", "nullable": true }, "couponCodesMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shippingTotal": { "type": "number", "description": "Total shipping cost", "format": "decimal", "nullable": true, "readOnly": true }, "handlingTotal": { "type": "number", "description": "Cost of handling", "format": "decimal", "nullable": true }, "orderLevelTax": { "type": "number", "description": "Order level tax amount", "format": "decimal", "nullable": true }, "taxTotal": { "type": "number", "description": "Total tax amount (line item level and order level)", "format": "decimal", "nullable": true }, "discountAmount": { "type": "number", "description": "Total discount amount", "format": "decimal", "nullable": true }, "subTotal": { "type": "number", "description": "Ordrer total without shipment cost", "format": "decimal", "nullable": true }, "subTotalExclTax": { "type": "number", "description": "Ordrer total without shipment cost and without tax", "format": "decimal", "nullable": true }, "total": { "type": "number", "description": "Order total, including shipment cost, tax, and discounts", "format": "decimal", "nullable": true }, "totalExclTax": { "type": "number", "description": "Order total, including shipment cost and discounts, but without tax", "format": "decimal", "nullable": true }, "authorizedPaymentTotal": { "type": "number", "description": "Total amount authorized by payment providers", "format": "decimal", "nullable": true }, "capturedPaymentTotal": { "type": "number", "description": "Total amount captured by payment providers", "format": "decimal", "nullable": true }, "creditPaymentTotal": { "type": "number", "description": "Total amount credited by payment providers", "format": "decimal", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "charges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCharge" }, "description": "A list of additional charges for the order", "nullable": true }, "fullRefund": { "type": "boolean", "description": "True if order should be fully refunded", "nullable": true }, "isPriority": { "type": "boolean", "description": "Possible to mark the order with priority", "nullable": true }, "chargeShipmentCostAmount": { "type": "number", "description": "Patch amount for shipment cost charged the customer", "format": "decimal", "nullable": true }, "creditShipmentAmount": { "type": "number", "description": "Patch amount for shipment cost to credit customer", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Order form, containing shipments, payments and line items for order" }, "OmniumOrderGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "Order group ID", "nullable": true }, "name": { "type": "string", "description": "Order group name", "nullable": true }, "description": { "type": "string", "description": "Order group description", "nullable": true } }, "additionalProperties": false, "description": "Used for grouping order lines" }, "OmniumOrderLine": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item ID / Order Line ID - REQUIRED", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external order line IDs", "nullable": true }, "code": { "type": "string", "description": "SKU", "nullable": true }, "ean": { "type": "string", "description": "Product EAN / GTIN number", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN numbers", "nullable": true }, "displayName": { "type": "string", "description": "Product display name", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Additional or alternative product name", "nullable": true }, "placedPrice": { "type": "number", "description": "The price for one item, without discounts, i.e. list price", "format": "decimal" }, "placedPriceExclTax": { "type": "number", "description": "Calculated - The price for one item, without discounts, i.e. list price, without tax", "format": "decimal" }, "extendedPrice": { "type": "number", "description": "Calculated - Total line item price with all discounts applied, including item and order level discounts", "format": "decimal" }, "extendedPriceExclTax": { "type": "number", "description": "Calculated - Total line item price with all discounts applied, including item and order level discounts, without tax", "format": "decimal" }, "priceListId": { "type": "string", "description": "Calculated - Reference to connected price list. Used in the context of 'PriceFactor'", "nullable": true }, "priceListItemId": { "type": "string", "description": "Calculated - Reference to connected price list item. Used in the context of 'PriceFactor'", "nullable": true }, "discountedPrice": { "type": "number", "description": "Calculated - Total line item price with all item discounts applied. Without order discounts.", "format": "decimal" }, "discountedPriceExclTax": { "type": "number", "description": "Calculated - Total line item price with all item discounts applied. Without order discounts. Without tax.", "format": "decimal" }, "lineItemDiscountAmount": { "type": "number", "description": "(OBSOLETE: Use property on Discounted instead) Calculated - Total line item discount.", "format": "decimal", "deprecated": true }, "lineItemDiscountAmountExclTax": { "type": "number", "description": "(OBSOLETE: Use property on DiscountedPriceExclTax instead) Calculated - Total line item discount excl. tax.", "format": "decimal", "deprecated": true }, "suggestedRetailPrice": { "type": "number", "description": "Suggested retail price. Not used in any calculations. Only used for reports or statistics by third party applications.", "format": "decimal" }, "suggestedRetailPriceExclTax": { "type": "number", "description": "Suggested retail price without tax. Not used in any calculations. Only used for reports or statistics by third party applications.", "format": "decimal" }, "orderDiscountAmount": { "type": "number", "description": "Calculated - This order line's share of the order level discounts", "format": "decimal" }, "creditedAmount": { "type": "number", "description": "Calculated - credited amount for order line", "format": "decimal" }, "originalExtendedPricePerUnit": { "type": "number", "description": "Calculated - Original extended price per unit before cancellation, used for credit calculations when ExtendedPrice becomes 0 after full cancellation", "format": "decimal", "nullable": true }, "comment": { "type": "string", "description": "Order line comment", "nullable": true }, "quantity": { "type": "number", "description": "Number of ordered items", "format": "decimal" }, "unit": { "type": "string", "description": "Quantity unit - e.g. Meter,Pcs,Litre, etc", "nullable": true }, "selectedUnit": { "type": "string", "description": "The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)", "nullable": true }, "selectedUnitConversionFactor": { "type": "number", "description": "Conversion factor from default unit to selected unit", "format": "decimal", "nullable": true }, "selectedUnitQuantity": { "type": "number", "description": "The quantity ordered in the selected unit of measurement.", "format": "decimal", "nullable": true }, "returnQuantity": { "type": "number", "description": "Number of items returned", "format": "decimal" }, "returnReason": { "type": "string", "description": "Return reason comment", "nullable": true }, "returnDate": { "type": "string", "description": "Date returned", "format": "date-time", "nullable": true }, "returnType": { "type": "string", "description": "Return type ID (should correspond to preconfigured list of return types)", "nullable": true }, "canceledQuantity": { "type": "number", "description": "Number of items cancelled", "format": "decimal" }, "canceledDate": { "type": "string", "format": "date-time", "nullable": true }, "cancelReason": { "type": "string", "description": "Reason / type of order line cancellation", "nullable": true }, "cancelComment": { "type": "string", "description": "Comment regarding cancellation", "nullable": true }, "deliveredQuantity": { "type": "number", "description": "Number of items delivered", "format": "decimal" }, "customerPickupDeadline": { "type": "string", "description": "Deadline for when the customer needs to pick up the order line (Used for partial deliveries)", "format": "date-time", "nullable": true }, "storePickDate": { "type": "string", "description": "Deadline for when the store needs to pick the order line (Used for partial deliveries)", "format": "date-time", "nullable": true }, "readyForPickupQuantity": { "type": "number", "description": "Number of items ready for pick up", "format": "decimal", "nullable": true }, "readyForPickupDate": { "type": "string", "description": "Date orderLine is ready for pick up", "format": "date-time", "nullable": true }, "isGift": { "type": "boolean", "description": "If item should be sent as a gift" }, "isBackorder": { "type": "boolean", "description": "Product on order line can be back-ordered" }, "isReadOnly": { "type": "boolean", "description": "Mark the order line as read only." }, "isReadOnlyByCustomer": { "type": "boolean", "description": "Mark the order line as read only for the customer. Typically used for carts where there should be order lines that the customer should not be allowed to modify." }, "cost": { "type": "number", "description": "Enriched from product data: Item cost", "format": "decimal" }, "costTotal": { "type": "number", "description": "Calculated - Total cost for all items", "format": "decimal" }, "discounted": { "type": "number", "description": "Total line item discount", "format": "decimal" }, "discountedExclTax": { "type": "number", "description": "Total line item discount without tax", "format": "decimal" }, "taxTotal": { "type": "number", "description": "Calculated - Total tax for order line", "format": "decimal" }, "taxRate": { "type": "number", "description": "Tax rate in percent. If tax is 25%, value here should be 25.00. If not set(null) tax from market will be used.", "format": "decimal", "nullable": true }, "campaignId": { "type": "string", "description": "Optional campaign id", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "size": { "type": "string", "description": "Enriched by product data - item size", "nullable": true }, "color": { "type": "string", "description": "Enriched by product data - name of color", "nullable": true }, "brand": { "type": "string", "description": "Enriched by product data - name of brand", "nullable": true }, "productType": { "type": "string", "description": "Product type", "nullable": true }, "supplierId": { "type": "string", "description": "Supplier ID", "nullable": true }, "supplierSkuId": { "type": "string", "description": "Supplier Sku ID", "nullable": true }, "supplierName": { "type": "string", "description": "Supplier name", "nullable": true }, "productId": { "type": "string", "description": "Enriched by product data: Product ID", "nullable": true }, "imageUrl": { "type": "string", "description": "Enriched by product data: Product image URL", "nullable": true }, "orderLineDiscounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineDiscount" }, "description": "Discounts valid for this order line", "nullable": true }, "orderLineBonusPoints": { "$ref": "#/components/schemas/OmniumOrderLineBonusPoints" }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date for order line", "format": "date-time", "nullable": true }, "serialNumber": { "type": "string", "description": "Serial number for order line", "nullable": true }, "isSerializableProduct": { "type": "boolean", "description": "Indicates whether the product requires a serial number", "nullable": true }, "isRental": { "type": "boolean", "description": "Indicates whether the order line represents a rental product. Rental dates are stored in Properties (keys: RentalFrom, RentalTo)." }, "packageSkuId": { "type": "string", "description": "Package sku ID / Code (used if product is part of package)", "nullable": true }, "packageLineItemId": { "type": "string", "description": "Package line item ID (used if product is part of package)", "nullable": true }, "componentId": { "type": "string", "description": "Applicable only when the order line represents a component. Stores the identifier of the corresponding component within the parent package's component list.", "nullable": true }, "webSiteProductUrl": { "type": "string", "description": "Public website URL to product", "nullable": true }, "updateStock": { "type": "boolean", "description": "Used by order return. If we should increase stock" }, "replacedQuantity": { "type": "number", "description": "Number of items replaced (if a replacement order has been created)", "format": "decimal", "nullable": true }, "replacedDate": { "type": "string", "description": "Replaced date (if a replacement order has been created)", "format": "date-time", "nullable": true }, "replacementType": { "type": "string", "description": "Type of replacement (should correspond to preconfigured list of replacement types)", "nullable": true }, "replacementReason": { "type": "string", "description": "Reason for replacement", "nullable": true }, "isPackage": { "type": "boolean", "description": "(OBSOLETE: Use 'IsPackageProduct' or 'IsPackageBrokeDown' instead) If true, product is a package with broken down components. Breakdown is skipped.", "deprecated": true }, "isBundle": { "type": "boolean", "description": "If true, product is a bundle with components. Prices are unchanged on broken down components and should be 0 on the bundle itself." }, "isPackageProduct": { "type": "boolean", "description": "If true, product is a package with components. Packages have their own 'package' price (price required). Broken down components price will be set to 0." }, "isPackageBrokeDown": { "type": "boolean", "description": "If true, package/bundle breakdown is skipped" }, "isVirtualProduct": { "type": "boolean", "description": "Indicates whether the product on the order line is a virtual product. Virtual products, such as gift cards or other electronic products, do not require or affect inventory" }, "isConfigurableProduct": { "type": "boolean", "description": "Indicates whether the order line represents a configurable product. This value is set when a configurable product is created from the cart. Configurable products exist only as order lines and do not have standalone product entries" }, "modifiedReason": { "type": "string", "description": "Reason for order line modification", "nullable": true }, "createPurchaseOrder": { "type": "boolean", "description": "If true, purchase order should be created from order line", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Used for specification of package products", "nullable": true }, "reservedInventoryQuantity": { "type": "number", "description": "Calculated: Reserved inventory", "format": "decimal" }, "isAwaitingPurchaseOrder": { "type": "boolean", "description": "If true, order line is reserved on an incoming purchase order. Order lines with this flag will not be reserved on regular inventory items.", "nullable": true }, "reservedInventoryPurchaseOrderId": { "type": "string", "description": "Calculated: Reserved inventory purchase order ID", "nullable": true }, "reservedInventoryPurchaseOrderLineId": { "type": "string", "description": "Calculated: Reserved purchase order line ID", "nullable": true }, "reservedInventory": { "type": "boolean", "description": "Calculated: True if inventory is reserved" }, "reservedInventoryDeliveryId": { "type": "string", "description": "Calculated: Reservation delivery ID", "nullable": true }, "groupId": { "type": "string", "description": "Order line group ID (should correspond to ID on order.groups)", "nullable": true }, "deliveredDate": { "type": "string", "description": "Date of orderline delivery", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Requested delivery date for the orderline", "format": "date-time", "nullable": true }, "internalWarehouseLocation": { "type": "string", "description": "Date of orderline delivery", "nullable": true }, "isExcludedFromPromotions": { "type": "boolean", "description": "If true promotion prices are not recalculated for this order line.", "nullable": true }, "isPriceLocked": { "type": "boolean", "description": "When true, the price is locked and will not be recalculated. Also sets IsExcludedFromPromotions to true.", "nullable": true }, "discountReasonCode": { "type": "string", "description": "Reason code for manual discount applied to this order line (audit trail).", "nullable": true }, "isSkuAccessory": { "type": "boolean", "description": "Indicates whether the order line represents a product option/accessory that is attached to another line item.", "nullable": true }, "salesOrigin": { "type": "string", "description": "The origin/source of this order line (e.g. \"Omnium\" for UI-created lines, or values set by external systems)", "nullable": true }, "salesOriginId": { "type": "string", "description": "The ID of the sales channel or register that created or last modified this order line (e.g. the InStore register ID)", "nullable": true } }, "additionalProperties": false, "description": "Order line" }, "OmniumOrderLineBonusPoints": { "type": "object", "properties": { "newPointsOnHold": { "type": "number", "description": "Points that will be valid when order is processed", "format": "decimal" }, "earnedPoints": { "type": "number", "description": "Points after the order is processed", "format": "decimal" } }, "additionalProperties": false, "description": "Bonus point information for one order line" }, "OmniumOrderLineDiscount": { "type": "object", "properties": { "discountAmountPrItem": { "type": "number", "description": "The discount amount per single item/unit on this order line.\r\nTotal line discount = DiscountAmountPrItem * Quantity\r\nExample: For a \"3 for 2\" promotion where each item is normally 100, this would be ~33.33 (the discount portion per item).", "format": "decimal" }, "discountId": { "type": "string", "description": "Unique identifier for this discount. Used to track and reference specific discount instances.", "nullable": true }, "discountAmount": { "type": "number", "description": "The calculated discount amount in the order's currency.\r\nThis is the actual monetary value that will be deducted from the order/line total.\r\nFor percentage-based discounts, this is calculated from DiscountValue.", "format": "decimal" }, "maxDiscountAmount": { "type": "number", "description": "Maximum cap for the discount amount.\r\nUseful for percentage discounts where you want to limit the maximum deduction.\r\nExample: \"20% off, maximum 100 NOK\" - set DiscountValue=20, RewardType=\"Percentage\", MaxDiscountAmount=100", "format": "decimal" }, "discountCode": { "type": "string", "description": "Coupon or promotion code that triggered this discount.\r\nUsed for tracking and for customers who enter promotional codes at checkout.", "nullable": true }, "discountName": { "type": "string", "description": "Display name for the discount, shown to customers and in reports.\r\nExample: \"Summer Sale 20%\", \"3 for 2 on selected items\", \"Free shipping\"", "nullable": true }, "discountValue": { "type": "number", "description": "The discount value used together with RewardType to calculate the actual discount.\r\n- For RewardType \"Money\": The fixed amount to deduct (e.g., 50 = 50 NOK off)\r\n- For RewardType \"Percentage\": The percentage to deduct (e.g., 20 = 20% off)\r\n- For RewardType \"Free\": Typically 100 (100% off)\r\n- For RewardType \"FixedPrice\" and \"MultiBuys\": Use the corresponding reward objects instead", "format": "decimal" }, "discountSource": { "type": "string", "description": "Indicates how the discount was created.\r\nValues: \"Manual\" (added by user/API), \"Campaign\" (from promotion engine)", "nullable": true }, "rewardType": { "type": "string", "description": "Defines how DiscountValue is interpreted and applied.\r\nValues:\r\n- \"None\" (0): No reward\r\n- \"Money\" (1): Fixed monetary discount (e.g., 50 NOK off)\r\n- \"Percentage\" (2): Percentage discount (e.g., 20% off)\r\n- \"Free\" (3): Item is free (100% off)\r\n- \"FixedPrice\" (4): Items for a fixed total price (e.g., \"4 for 99\"). Requires PromotionFixedPriceReward\r\n- \"Gift\" (5): Free gift item included\r\n- \"MultiBuys\" (6): Multi-buy offer (e.g., \"3 for 2\"). Requires PromotionMultiBuyReward\r\n- \"Kit\" (7): Set discount (buy one item from each of groups A, B, C and get discount on the set)", "nullable": true }, "priority": { "type": "integer", "description": "Priority determines the order in which discounts are applied when multiple discounts exist.\r\nLower values are applied first (0 = highest priority, applied first).\r\nImportant when combining discounts, as earlier discounts affect the base for later percentage calculations.", "format": "int32" }, "canBeCombinedWithOtherPromotions": { "type": "boolean", "description": "When true, this discount can be stacked with other promotions.\r\nWhen false, applying this discount may exclude other discounts depending on configuration." }, "alwaysApply": { "type": "boolean", "description": "When true, this discount is always applied regardless of CanBeCombinedWithOtherPromotions on other discounts.\r\nUse for discounts that should never be blocked by exclusivity rules." }, "isBonusPointsReward": { "type": "boolean", "description": "When true, the reward is given as customer club bonus points instead of a price reduction.\r\nOnly applicable for customer club promotions." }, "promotionMultiBuyReward": { "$ref": "#/components/schemas/OmniumPromotionMultiBuyReward" }, "promotionFixedPriceReward": { "$ref": "#/components/schemas/OmniumPromotionFixedPriceReward" } }, "additionalProperties": false, "description": "Represents a discount applied specifically to an order line item.\r\nThis is used when retrieving orders to show which discounts were applied to each line item.\r\nFor line-item discounts from FixedPrice or MultiBuys promotions, the discount amounts are distributed across the involved order lines." }, "OmniumOrderLineIdRequest": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID", "nullable": true }, "lineItemIds": { "type": "array", "items": { "type": "string" }, "description": "List of line item IDs", "nullable": true } }, "additionalProperties": false, "description": "Request object for order ID and corresponding line items" }, "OmniumOrderLinePatch": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item ID", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external order line IDs", "nullable": true }, "code": { "type": "string", "description": "Product / SKU number", "nullable": true }, "ean": { "type": "string", "description": "Product EAN / GTIN number", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "Product GTIN number", "nullable": true }, "displayName": { "type": "string", "description": "Product display name", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Additional or alternative product name", "nullable": true }, "placedPrice": { "type": "number", "description": "The price for one item, without discounts, i.e. list price", "format": "decimal", "nullable": true }, "placedPriceExclTax": { "type": "number", "description": "The price for one item, without discounts, i.e. list price, without tax", "format": "decimal", "nullable": true }, "extendedPrice": { "type": "number", "description": "Calculated - Total line item price with all discounts applied, including item and order level discounts", "format": "decimal", "nullable": true }, "extendedPriceExclTax": { "type": "number", "description": "Calculated - Total line item price with all discounts applied, including item and order level discounts, without tax", "format": "decimal", "nullable": true }, "priceListId": { "type": "string", "description": "Calculated - Reference to connected price list. Used in the context of 'PriceFactor'", "nullable": true }, "priceListItemId": { "type": "string", "description": "Calculated - Reference to connected price list item. Used in the context of 'PriceFactor'", "nullable": true }, "discountedPrice": { "type": "number", "description": "Calculated - Total line item price with all item discounts applied. Without order disounts.", "format": "decimal", "nullable": true }, "discountedPriceExclTax": { "type": "number", "description": "Calculated - Total line item price with all item discounts applied. Without order disounts. Without tax.", "format": "decimal", "nullable": true }, "suggestedRetailPrice": { "type": "number", "description": "Suggested retail price. Not used in any calculations. Only used for reports or statistics by third party applications.", "format": "decimal", "nullable": true }, "suggestedRetailPriceExclTax": { "type": "number", "description": "Suggested retail price withoud tax. Not used in any calculations. Only used for reports or statistics by third party applications.", "format": "decimal", "nullable": true }, "orderDiscountAmount": { "type": "number", "description": "Calculated - This orderlines share of the order level discounts", "format": "decimal", "nullable": true }, "comment": { "type": "string", "description": "Order line comment", "nullable": true }, "quantity": { "type": "number", "description": "Number of items", "format": "decimal", "nullable": true }, "unit": { "type": "string", "description": "Quantity unit - e.g. Meter,Pcs,Litre, etc", "nullable": true }, "selectedUnit": { "type": "string", "description": "The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)", "nullable": true }, "selectedUnitConversionFactor": { "type": "number", "description": "Conversion factor from default unit to selected unit", "format": "decimal", "nullable": true }, "selectedUnitQuantity": { "type": "number", "description": "The quantity ordered in the selected unit of measurement.", "format": "decimal", "nullable": true }, "returnQuantity": { "type": "number", "description": "Number of items returned", "format": "decimal", "nullable": true }, "returnReason": { "type": "string", "description": "Return reason comment", "nullable": true }, "returnDate": { "type": "string", "description": "Date returned", "format": "date-time", "nullable": true }, "returnType": { "type": "string", "description": "Return type ID (should correspond to preconfigured list of return types)", "nullable": true }, "canceledQuantity": { "type": "number", "description": "Number of items cancelled", "format": "decimal", "nullable": true }, "canceledDate": { "type": "string", "description": "Date of cancellation", "format": "date-time", "nullable": true }, "cancelReason": { "type": "string", "description": "Reason / type of order line cancellation", "nullable": true }, "cancelComment": { "type": "string", "description": "Comment regarding cancellation", "nullable": true }, "deliveredQuantity": { "type": "number", "description": "Number of items delivered", "format": "decimal", "nullable": true }, "customerPickupDeadline": { "type": "string", "description": "Deadline for when the customer needs to pick up the order line (Used for partial deliveries)", "format": "date-time", "nullable": true }, "storePickDate": { "type": "string", "description": "Deadline for when the store needs to pick the order line (Used for partial deliveries)", "format": "date-time", "nullable": true }, "isGift": { "type": "boolean", "description": "If item should be sent as a gift", "nullable": true }, "isReadOnly": { "type": "boolean", "description": "Is order line read only for customer", "nullable": true }, "cost": { "type": "number", "description": "Item cost", "format": "decimal", "nullable": true }, "costTotal": { "type": "number", "description": "Total cost for all items", "format": "decimal", "nullable": true }, "discounted": { "type": "number", "description": "Total line item discount", "format": "decimal", "nullable": true }, "discountedExclTax": { "type": "number", "description": "Total line item discount without tax", "format": "decimal", "nullable": true }, "taxTotal": { "type": "number", "description": "Total tax for order line", "format": "decimal", "nullable": true }, "taxRate": { "type": "number", "description": "Tax rate in percent. If tax is 25%, value here should be 25.00. If not set(null) tax from market will be used.", "format": "decimal", "nullable": true }, "campaignId": { "type": "string", "description": "Optional campaign id", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "size": { "type": "string", "description": "Item size", "nullable": true }, "color": { "type": "string", "description": "Item color", "nullable": true }, "brand": { "type": "string", "description": "Brand name", "nullable": true }, "productType": { "type": "string", "description": "Product type", "nullable": true }, "supplierId": { "type": "string", "description": "Supplier ID", "nullable": true }, "supplierSkuId": { "type": "string", "description": "Supplier SKU ID", "nullable": true }, "supplierName": { "type": "string", "description": "Supplier name", "nullable": true }, "productId": { "type": "string", "description": "Product ID", "nullable": true }, "imageUrl": { "type": "string", "description": "Product image URL", "nullable": true }, "orderLineDiscounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLineDiscount" }, "description": "Discounts valid for this orderline", "nullable": true }, "orderLineBonusPoints": { "$ref": "#/components/schemas/OmniumOrderLineBonusPoints" }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date for order line", "format": "date-time", "nullable": true }, "serialNumber": { "type": "string", "description": "Serial number for order line", "nullable": true }, "isSerializableProduct": { "type": "boolean", "description": "Indicates whether the product requires a serial number", "nullable": true }, "packageSkuId": { "type": "string", "description": "Package sku ID / Code (used if product is part of package)", "nullable": true }, "packageLineItemId": { "type": "string", "description": "Package line item ID (used if product is part of package)", "nullable": true }, "webSiteProductUrl": { "type": "string", "description": "Public website URL to product", "nullable": true }, "updateStock": { "type": "boolean", "description": "Used by order return. If we should increase stock", "nullable": true }, "creditedAmount": { "type": "number", "description": "Line item credited amount", "format": "decimal", "nullable": true }, "replacedQuantity": { "type": "number", "description": "Number of items replaced", "format": "decimal", "nullable": true }, "replacedDate": { "type": "string", "description": "Replaced date", "format": "date-time", "nullable": true }, "replacementType": { "type": "string", "description": "Type of replacement", "nullable": true }, "replacementReason": { "type": "string", "description": "Reason for replacement", "nullable": true }, "isPackage": { "type": "boolean", "description": "If true, product is a product with components", "nullable": true }, "isVirtualProduct": { "type": "boolean", "description": "Indicates whether the product on the order line is a virtual product. Virtual products, such as gift cards or other electronic products, do not require or affect inventory", "nullable": true }, "isConfigurableProduct": { "type": "boolean", "description": "Indicates whether the order line represents a configurable product. This value is set when a configurable product is created from the cart. Configurable products exist only as order lines and do not have standalone product entries" }, "reservedInventoryQuantity": { "type": "number", "description": "Reserved inventory", "format": "decimal", "nullable": true }, "reservedInventoryPurchaseOrderId": { "type": "string", "description": "Reserved inventory purchase order ID", "nullable": true }, "reservedInventoryPurchaseOrderLineId": { "type": "string", "description": "Reserved purchase order line ID", "nullable": true }, "reservedInventory": { "type": "boolean", "description": "True if inventory is reserved", "nullable": true }, "reservedInventoryDeliveryId": { "type": "string", "description": "Reservation delivery ID", "nullable": true }, "isAwaitingPurchaseOrder": { "type": "boolean", "description": "If true, order line is reserved on an incoming purchase order", "nullable": true }, "deliveredDate": { "type": "string", "description": "DateTime of delivery of lineItem", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "DateTime of requested delivery date for line item", "format": "date-time", "nullable": true }, "internalWarehouseLocation": { "type": "string", "description": "For return: Use this to specify the warehouseLocation within a warehouse, Example Broken/Used/SellAsNew or front/back", "nullable": true }, "isSkuAccessory": { "type": "boolean", "description": "Indicates whether the order line represents a product option/accessory that is attached to another line item.", "nullable": true }, "discountReasonCode": { "type": "string", "description": "Reason code for manual discount applied to this order line (audit trail).", "nullable": true }, "isExcludedFromPromotions": { "type": "boolean", "description": "If true, promotion prices are not recalculated for this order line.", "nullable": true }, "isPriceLocked": { "type": "boolean", "description": "When true, the price is locked and will not be recalculated. Also sets IsExcludedFromPromotions to true.", "nullable": true }, "salesOrigin": { "type": "string", "description": "The origin/source of this order line (e.g. \"Omnium\" for UI-created lines, or values set by external systems)", "nullable": true } }, "additionalProperties": false, "description": "Order line patch" }, "OmniumOrderLineSettings": { "type": "object", "properties": { "defaultProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDefaultPropertyItem" }, "nullable": true }, "splitMultibuyPromotionOrderLines": { "type": "boolean" } }, "additionalProperties": false }, "OmniumOrderLineUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true }, "isModified": { "type": "boolean" } }, "additionalProperties": false }, "OmniumOrderOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumOrderOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumOrderOmniumVersion": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/OmniumOrder" } }, "additionalProperties": false }, "OmniumOrderOmniumWorkflowActionRequest": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/OmniumOrder" }, "workflowStep": { "$ref": "#/components/schemas/OmniumWorkflowStep" }, "shipmentId": { "type": "string", "nullable": true }, "returnOrderFormId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Represents a request to perform a workflow action in the Omnium system.\r\nThis generic class allows for flexibility by supporting various models,\r\nsuch as orders, purchase orders, or products, in different workflows." }, "OmniumOrderPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique order ID", "nullable": true }, "orderNumber": { "type": "string", "description": "Order identifier - does not have to be unique for each store, market etc", "nullable": true }, "customerId": { "type": "string", "description": "The ID of the customer - should be a unique value", "nullable": true }, "customerNumber": { "type": "string", "description": "The customer number", "nullable": true }, "billingCurrency": { "type": "string", "description": "Currency of the order. e.g. \"USD\",\"NOK\"", "nullable": true }, "customerClubMemberId": { "type": "string", "description": "If Customer is member of customer club, set Customer ID as member ID.", "nullable": true }, "customerName": { "type": "string", "description": "Name of customer", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone number with prefix. e.g. +4740000000", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "customerType": { "type": "string", "description": "B2B or B2C (Business customer or private customer / consumer)", "nullable": true }, "marketId": { "type": "string", "description": "Market ID e.g. US, NOR, SWE", "nullable": true }, "billingAddress": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "orderForm": { "$ref": "#/components/schemas/OmniumOrderFormPatch" }, "status": { "type": "string", "description": "Order status, e.g. \"New\", \"InProgress\", \"Cancelled\", etc.", "nullable": true }, "remainingPayment": { "type": "number", "description": "Amount not paid", "format": "decimal", "nullable": true }, "salesPersonId": { "type": "string", "description": "id of seller", "nullable": true }, "salesPersonName": { "type": "string", "description": "Name of seller", "nullable": true }, "salesChannel": { "type": "string", "description": "Name of sales channel", "nullable": true }, "modifiedBy": { "type": "string", "description": "Modified by", "nullable": true }, "created": { "type": "string", "description": "Order created date", "format": "date-time", "nullable": true }, "followUpDate": { "type": "string", "description": "Order follow-up date", "format": "date-time", "nullable": true }, "received": { "type": "string", "description": "Order received date", "format": "date-time", "nullable": true }, "customerPickupDeadline": { "type": "string", "description": "Customer deadline for picking up order", "format": "date-time", "nullable": true }, "storePickDate": { "type": "string", "description": "Employee deadline for picking order", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Delivery date requested by customer", "format": "date-time", "nullable": true }, "updateStatusDate": { "type": "string", "description": "Date when order should be moved to next status. (Updated by UpdateOrderStatusScheduledTask)", "format": "date-time", "nullable": true }, "nextOrderStatus": { "type": "string", "description": "Status order should be moved to. (Updated by UpdateOrderStatusScheduledTask)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "paymentType": { "type": "string", "description": "Name of payment provider", "nullable": true }, "orderType": { "type": "string", "description": "Order type e.g. \"Online\", \"Pos\"...", "nullable": true }, "storeId": { "type": "string", "description": "Store ID responsible for order", "nullable": true }, "returnOrderForms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderFormPatch" }, "description": "Returns", "nullable": true }, "customerReference": { "type": "string", "description": "Reference provided by customer", "nullable": true }, "customerContact": { "type": "string", "description": "Customer contact person", "nullable": true }, "customerRequisition": { "type": "string", "description": "Customer requisition provided by customer", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/OmniumContactPerson" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external order IDs", "nullable": true }, "isReadOnly": { "type": "boolean", "description": "If true, the order is not editable in Omnium. Used for completed PoS orders, historic data etc", "nullable": true }, "isNotificationsDisabled": { "type": "boolean", "description": "If true, notifications will not be sent to customer", "nullable": true }, "relatedOrders": { "type": "array", "items": { "type": "string" }, "description": "List of related order IDs", "nullable": true }, "session": { "type": "string", "description": "Session code used for referencing a web session", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Order assets (documents, media, files)", "nullable": true }, "replacementOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of replacement order IDs for this order", "nullable": true }, "projectId": { "type": "string", "description": "Project ID - used if order is part of a project", "nullable": true }, "subscriptionId": { "type": "string", "description": "Subscription ID - used if order is part of a subscription", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Order tags (Used by notification filters, and for grouping / filtering orders)", "nullable": true }, "ignorePromotions": { "type": "boolean", "description": "Promotion prices will be ignored when product added to cart", "nullable": true }, "orderOrigin": { "type": "string", "description": "The origin of the order should identify where the order was created. Typical values are \"OMS\", \"ERP\", \"WEB\" or \"POS\".", "nullable": true }, "orderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, for internal use / not for customer", "nullable": true }, "publicOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Order comments, visible for customer", "nullable": true }, "forceUpdate": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Used to update nullable prop like datetime to null, if original object has value, and you want to set null(remove value)\r\nProperty name should then be in this list. Like \"AuthorizationExpires\" for a payment\r\nNB: Only impl for AuthorizationExpires at the moment", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the current order.", "nullable": true }, "keepExistingListItems": { "type": "boolean", "description": "Determines behaviour when updating list where items does not have unique id (properties, errors). If true, new items will be added to the existing list.\r\nIf false, the existing list will be replaced with the new list. 'True' by default.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer groups (for discount calculation)", "nullable": true }, "invoiceComment": { "type": "string", "description": "Invoice comment", "nullable": true } }, "additionalProperties": false, "description": "Omnium order patch object" }, "OmniumOrderPatchUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true }, "isModified": { "type": "boolean" } }, "additionalProperties": false }, "OmniumOrderSearchRequest": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number or order ID", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "selectedStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search to selected order statuses", "nullable": true }, "excludedStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude orders with given statuses", "nullable": true }, "excludedShipmentExternalIdProviders": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude orders where all shipments has external Ids from given providers", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "customerNumber": { "type": "string", "description": "Customer Number", "nullable": true }, "customerId": { "type": "string", "description": "Customer Id", "nullable": true }, "customerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer Ids", "nullable": true }, "contactPersonPhone": { "type": "string", "description": "Contact person phone number", "nullable": true }, "contactPersonEmail": { "type": "string", "description": "Contact person e-mail", "nullable": true }, "salesChannels": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Sales channels", "nullable": true }, "customerContact": { "type": "string", "description": "Customer contact person", "nullable": true }, "salesPersonId": { "type": "string", "description": "Sales person ID (e-mail of Omnium user)", "nullable": true }, "createdFrom": { "type": "string", "description": "Orders created from date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Orders created before date", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Orders modified from date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Orders modified before date", "format": "date-time", "nullable": true }, "readyForPickupFrom": { "type": "string", "description": "Orders ready to pick up from date", "format": "date-time", "nullable": true }, "readyForPickupTo": { "type": "string", "description": "Orders ready to pick up before date", "format": "date-time", "nullable": true }, "completedFrom": { "type": "string", "description": "Orders completed from date", "format": "date-time", "nullable": true }, "completedTo": { "type": "string", "description": "Orders completed before date", "format": "date-time", "nullable": true }, "followUpDateFrom": { "type": "string", "description": "Orders with follow-up from date", "format": "date-time", "nullable": true }, "followUpDateTo": { "type": "string", "description": "Orders with follow-up to date", "format": "date-time", "nullable": true }, "requestedDeliveryFrom": { "type": "string", "description": "Orders with requested delivery date from", "format": "date-time", "nullable": true }, "requestedDeliveryTo": { "type": "string", "description": "Orders with requested delivery date to", "format": "date-time", "nullable": true }, "urgent": { "type": "boolean", "description": "Urgent orders (pick limit or pickup limit exceeded)" }, "selectedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search by store IDs", "nullable": true }, "selectedMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search by market IDs", "nullable": true }, "orderType": { "type": "string", "description": "Limit to single order type. Use OrderTypes instead for filtering by multiple order types.", "nullable": true, "deprecated": true }, "productNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit to orders containing selected product numbers", "nullable": true }, "productSerialNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit to order containing selected product serial numbers", "nullable": true }, "productTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit to order containing selected product types", "nullable": true }, "selectedDiscounts": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit to orders containing selected discounts", "nullable": true }, "searchText": { "type": "string", "description": "Free search text", "nullable": true }, "inventoryStatus": { "type": "string", "description": "Limit search to inventory status (\"InStock\", \"PartiallyInStock\", \"NotInStock\")", "nullable": true }, "shippingMethodName": { "type": "string", "description": "Shipping method name", "nullable": true }, "shippingMethodNames": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Shipping method names", "nullable": true }, "paymentStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search to payment statuses (\"OverPaid\", \"Paid\", \"NotPaid\" or \"PartiallyPaid\")", "nullable": true }, "paymentTransactionTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter orders by payment transaction types (\"Authorization\", \"Capture\" for instance)", "nullable": true }, "paymentTransactionStatus": { "type": "string", "description": "Filter orders by payment transaction status (\"Failed\" for instance)", "nullable": true }, "paymentTransactionDateFrom": { "type": "string", "description": "Filter orders by payment transaction by date (from)", "format": "date-time", "nullable": true }, "paymentTransactionDateTo": { "type": "string", "description": "Filter orders by payment transaction by date (to)", "format": "date-time", "nullable": true }, "futureDeliveries": { "type": "boolean", "description": "Only show future deliveries (orders with future requested delivery date)" }, "hasErrors": { "type": "boolean", "description": "Only show orders with errors" }, "showOrdersWithAuthExpires": { "type": "boolean", "description": "Search orders with payment authorize about to expire" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search orders with external IDs", "nullable": true }, "shipmentExternalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search orders with shipment external IDs", "nullable": true }, "take": { "type": "integer", "description": "Number of orders to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "sortOrder": { "type": "string", "description": "Sort order for the results. Defaults to created date descending.\r\nPossible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, CustomerNameAscending, CustomerNameDescending\r\nStatusAscending, StatusDescending, OrderIdAscending, OrderIdDescending, StoreAscending, StoreDescending, TotalAscending, TotalDescending\r\nand DocumentID. If you do not care about the order you should use DocumentId", "nullable": true }, "projectId": { "type": "string", "description": "Search orders by project ID", "nullable": true }, "subscriptionId": { "type": "string", "description": "Search orders by subscription ID", "nullable": true }, "property": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Search orders by properties, value, key, keyGroup or valueType", "nullable": true }, "picklistIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Only orders which appear on the pick list.", "nullable": true }, "disableFacets": { "type": "boolean", "description": "Set to true to disable facet generation. Disabling facets will improve performance and reduce data payload.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by excluding tags", "nullable": true }, "secretKey": { "type": "string", "description": "Search by order secret key", "nullable": true }, "shipmentOrderStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search to orders with shipments matching given shipment order statuses", "nullable": true }, "orderTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit to multiple order types", "nullable": true }, "orderLineIsAwaitingPurchaseOrder": { "type": "boolean", "description": "Filter orders containing order lines where IsAwaitingPurchaseOrder matches (true/false)", "nullable": true } }, "additionalProperties": false, "description": "Order search request" }, "OmniumOrderSettings": { "type": "object", "properties": { "shouldOrderStoreIdBeSavedOnCustomer": { "type": "boolean" }, "shouldOrderMarketIdBeSavedOnCustomer": { "type": "boolean" }, "shouldOrderExternalIdsBeSavedOnCustomer": { "type": "boolean" }, "shouldCustomerExternalIdsBeSavedOnOrder": { "type": "boolean" }, "shouldOrderPropertiesBeSavedOnCustomer": { "type": "boolean" }, "shouldCustomerPropertiesBeSavedOnOrder": { "type": "boolean" }, "isOrderCalculatorRunOnImport": { "type": "boolean" }, "giftCardTemplate": { "type": "string", "nullable": true }, "giftCardSku": { "type": "string", "nullable": true }, "giftCardCompletedStatus": { "type": "string", "nullable": true }, "defaultExchangeTerms": { "type": "string", "nullable": true }, "returnSettings": { "$ref": "#/components/schemas/OmniumReturnSettings" }, "replacementSettings": { "$ref": "#/components/schemas/OmniumReplacementSettings" }, "showOrderTotalsExTax": { "type": "boolean" }, "showOrderLinesExTax": { "type": "boolean" }, "uneditableExternalIDs": { "type": "boolean" }, "availableManualWorkflowSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderWorkflowStep" }, "nullable": true }, "defaultReplacementOrderType": { "type": "string", "description": "If set, replacement orders that are created will get this type. If not set, the type will be inherited from the order that was replaced", "nullable": true }, "tagSettings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTagSettings" }, "nullable": true }, "includedOrderTypesForRevenueStats": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "If set, these order types will be included in key numbers, average order values and revenue stats. If not set, default order types 'Pos' and 'Online' will be used.", "nullable": true }, "useStatsOrderQueues": { "type": "boolean", "description": "If set, orders will be copied to statsOrders" }, "orderLineSettings": { "$ref": "#/components/schemas/OmniumOrderLineSettings" }, "isInvoiceOriginal": { "type": "boolean" } }, "additionalProperties": false }, "OmniumOrderStatus": { "type": "object", "properties": { "name": { "type": "string", "description": "Order status name", "nullable": true }, "displayName": { "type": "string", "description": "Alternative order status name", "nullable": true }, "isMainFilter": { "type": "boolean", "description": "Is main filter" }, "order": { "type": "integer", "description": "Status sort order index", "format": "int32" }, "condition": { "type": "string", "description": "Condition for showing order status (if more statuses has the same sort order)", "nullable": true }, "isCanceledStatus": { "type": "boolean", "description": "True if orders with this status are canceled" }, "isDeliveredStatus": { "type": "boolean", "description": "True if orders with this status are delivered to customer" }, "isInProgressStatus": { "type": "boolean", "description": "True if orders with this status are in progress" }, "isPicked": { "type": "boolean", "description": "True if orders with this status are canceled. Used by picklist to set correct status when order is ready to ship/pick up" }, "shipmentStatusUpdate": { "type": "string", "description": "If set, the shipments on order will get this status", "nullable": true }, "mainOrderStatus": { "type": "string", "description": "If all shipments(split shipment orders) on the order has same status, order will be updated to MainOrderStatus", "nullable": true }, "enforceAvailableStepsPolicy": { "type": "boolean", "description": "Set to true if selectable order statues should be retrived from AvailableSteps property.", "nullable": true }, "availableSteps": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of available next order statuses. Used if EnforceAvailableStepsPolicy is set to true", "nullable": true }, "workflowSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderWorkflowStep" }, "description": "Workflow steps to run", "nullable": true }, "translateKey": { "type": "string", "description": "Translation key for order status", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "updateStatusButtonIsDisabledInGui": { "type": "boolean", "description": "If true, the button for updating to the next order status will be disabled" } }, "additionalProperties": false }, "OmniumOrderStatusLogItem": { "type": "object", "properties": { "status": { "type": "string", "description": "The status the order entered at this point in the timeline.", "nullable": true }, "timestamp": { "type": "string", "description": "The exact time when the order first entered this status.\r\nStored in UTC.", "format": "date-time" }, "durationSincePreviousMs": { "type": "integer", "description": "The duration in milliseconds since the previous status was recorded.\r\nNull for the first status.", "format": "int64", "nullable": true } }, "additionalProperties": false, "description": "Represents a single step in an order's status timeline, including the timestamp of the status change and the duration since the previous step." }, "OmniumOrderType": { "type": "object", "properties": { "name": { "type": "string", "description": "Order type name (E.g. Online, ClickAndCollect, Pos, etc)", "nullable": true }, "enableEdit": { "type": "boolean", "description": "Is order editable in GUI" }, "enableCreateFromCart": { "type": "boolean", "description": "True if it is possible to create order type from cart" }, "disableWorkflow": { "type": "boolean", "description": "Temporary disable workflow for order type" }, "defaultOrderType": { "type": "boolean", "description": "True if order is default. Autofilter by default types in order list." }, "defaultExternalIdProvider": { "type": "string", "description": "External ID provider (Added to list of external IDs)", "nullable": true }, "orderStatuses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderStatus" }, "description": "List of available order statuses", "nullable": true }, "deriveOrderStatusFromShipments": { "type": "boolean", "description": "When enabled, order head status is derived from the main status of the highest qualifying sort order tier based on shipment statuses" } }, "additionalProperties": false }, "OmniumOrderWorkflowExecutionPatchResult": { "type": "object", "properties": { "orderActionExecutionResults": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderActionExecutionResult" }, "description": "List of action results", "nullable": true }, "isAborted": { "type": "boolean", "description": "True if workflow failed and is aborted" }, "orderPatch": { "$ref": "#/components/schemas/OmniumOrderPatch" } }, "additionalProperties": false, "description": "Order workflow execution result" }, "OmniumOrderWorkflowExecutionResult": { "type": "object", "properties": { "orderActionExecutionResults": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderActionExecutionResult" }, "description": "List of action results", "nullable": true }, "isAborted": { "type": "boolean", "description": "True if workflow failed and is aborted" }, "order": { "$ref": "#/components/schemas/OmniumOrder" } }, "additionalProperties": false, "description": "Order workflow execution result" }, "OmniumOrderWorkflowStep": { "type": "object", "properties": { "name": { "type": "string", "description": "Workflow step name", "nullable": true }, "active": { "type": "boolean", "description": "True if step should be run" }, "runAfterOrderIsSaved": { "type": "boolean", "description": "True if step should run after order is saved" }, "stopOnError": { "type": "boolean", "description": "If true, the workflow will continue if current step fails to execute" }, "translateKey": { "type": "string", "description": "Translation key for workflow step name", "nullable": true }, "connector": { "type": "string", "description": "Connector to use for workflow step", "nullable": true }, "isInvisible": { "type": "boolean", "description": "True if result should not be shown in GUI" }, "enabledForMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of markets where this workflow step should be enabled (all markets available if empty)", "nullable": true }, "disabledForMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of market IDs where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of storeIds where this workflow step should be enabled (all stores available if empty)", "nullable": true }, "disabledForStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of storeIds where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForWarehouses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of warehouses where this workflow step should be enabled (all warehouses available if empty)", "nullable": true }, "disabledForWarehouses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of warehouses where this workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForShipmentOptions": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of shipmentOptionNames where this workflow step should be enabled (all shipmentOptions available if empty)", "nullable": true }, "disabledForShipmentOptions": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of shipmentOptionNames where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Workflow step properties", "nullable": true }, "workflowStepConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderWorkflowStepCondition" }, "description": "Workflow conditions", "nullable": true }, "id": { "type": "string", "description": "Step ID (provided by Omnium)", "nullable": true }, "index": { "type": "integer", "description": "Index (for sorting)", "format": "int32" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external order IDs", "nullable": true }, "description": { "type": "string", "description": "Description of the step (what should be done by users during this step)", "nullable": true }, "acceptText": { "type": "string", "description": "Text on accept button (moving forward to the next step)", "nullable": true }, "declineText": { "type": "string", "description": "Text on decline button (moving backwards to the previous step)", "nullable": true }, "dateText": { "type": "string", "description": "Text describing a date input. User should be able to add date if this property has value.", "nullable": true }, "current": { "type": "boolean", "description": "True if this step is the current workflow step" }, "startDate": { "type": "string", "description": "Date the step was started", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "description": "Date the step was completed (if null, the step was never completed)", "format": "date-time", "nullable": true }, "hiddenFromCustomer": { "type": "boolean", "description": "If step should be hidden from customer" }, "hiddenFromPartner": { "type": "boolean", "description": "If step should be hidden from partner" }, "isCommentsDisabled": { "type": "boolean", "description": "If user should be able to enter comments on this step" } }, "additionalProperties": false }, "OmniumOrderWorkflowStepCondition": { "type": "object", "properties": { "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPatchLineItemIdsRequest": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order ID to patch line item IDs for (Required)", "nullable": true }, "lineItemIdMappings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/LineItemIdMapping" }, "description": "List of line item ID mappings (old ID to new ID)", "nullable": true } }, "additionalProperties": false, "description": "Request model for patching line item IDs across order, shipments, and return forms" }, "OmniumPatchLineItemIdsResult": { "type": "object", "properties": { "totalRequested": { "type": "integer", "description": "Total number of line item IDs that were requested to be updated", "format": "int32" }, "updatedCount": { "type": "integer", "description": "Number of line item IDs successfully updated", "format": "int32" }, "notFoundCount": { "type": "integer", "description": "Number of line item IDs that were not found", "format": "int32" }, "isModified": { "type": "boolean", "description": "Whether any modifications were made", "readOnly": true }, "details": { "$ref": "#/components/schemas/PatchLineItemIdsDetails" }, "errorMessage": { "type": "string", "description": "Any error messages", "nullable": true } }, "additionalProperties": false, "description": "Result model for patching line item IDs" }, "OmniumPatchMergeMode": { "enum": [ "UpdateOnly", "AddOrUpdate", "Replace" ], "type": "string", "description": "Controls how a list on an Omnium.Public.Orders.Models.Patch.OmniumOrderPatch (e.g. Payments, Shipments) is merged into the target." }, "OmniumPayment": { "type": "object", "properties": { "amount": { "type": "number", "description": "The monetary amount for this payment transaction.\r\nFor Authorization: The reserved/authorized amount\r\nFor Capture: The captured amount (can be less than or equal to authorization)\r\nFor Credit/Refund: The refunded amount", "format": "decimal" }, "authorizationCode": { "type": "string", "description": "Authorization code returned by the payment provider.\r\nUsed for reference and reconciliation with the payment provider.", "nullable": true }, "customerName": { "type": "string", "description": "Name of the customer associated with this payment.", "nullable": true }, "implementationClass": { "type": "string", "description": "Not in use - reserved for internal purposes.", "nullable": true }, "id": { "type": "string", "description": "Unique identifier for this specific payment record in Omnium.\r\nDifferent from TransactionId which is the provider's reference.\r\nWhen updating payments, matching is done on this Id.", "nullable": true }, "paymentId": { "type": "integer", "description": "Deprecated. Use TransactionId instead.", "format": "int32", "deprecated": true }, "paymentMethodId": { "type": "string", "description": "Deprecated. Use PaymentMethodName instead.", "format": "uuid", "deprecated": true }, "paymentMethodName": { "type": "string", "description": "Identifies the payment provider. Must match a configured provider name in Omnium.\r\nExamples: \"Klarna\", \"Vipps\", \"Stripe\", \"Adyen\", \"GiftCard\", \"Dintero\"\r\nThis determines which integration Omnium uses for capture/refund operations.", "nullable": true }, "paymentType": { "type": "string", "description": "Sub-type or method within the payment provider.\r\nExamples: \"Invoice\", \"Card\", \"Swish\", \"DirectDebit\"\r\nUsed to identify the specific payment method when a provider offers multiple options.", "nullable": true }, "status": { "type": "string", "description": "Current status of this payment transaction.\r\nValues:\r\n- \"Processed\": Transaction completed successfully\r\n- \"Failed\": Transaction failed\r\n- \"Pending\": Awaiting processing or confirmation\r\n- \"Paid\": Payment has been paid\r\n- \"Approved\": Payment has been approved", "nullable": true }, "transactionId": { "type": "string", "description": "Unique transaction identifier from the payment provider.\r\nThis is the provider's reference for the transaction and is required for subsequent operations (capture, refund).\r\nExample: Klarna order ID, Vipps order ID, Stripe payment intent ID", "nullable": true }, "transactionType": { "type": "string", "description": "The type of payment transaction.\r\n \r\nCommon values for API consumers:\r\n- \"Authorization\": Payment is reserved but not yet captured. Standard for e-commerce orders\r\n- \"Capture\": Payment has been captured/charged from the customer\r\n- \"Sale\": Payment is immediately captured (no separate authorization). Use for POS/in-store orders\r\n- \"Credit\": Refund/credit back to the customer\r\n- \"Invoiced\": Invoice-based payment (e.g., Klarna invoice)\r\n- \"Void\": Authorization has been cancelled/voided\r\n \r\nInternal/system values (typically set by Omnium, not API consumers):\r\n- \"AwaitingAuthorization\": Used internally for paylinks and in-store payments awaiting customer action\r\n- \"ReleaseRemainingAuthorization\": Release unused authorization amount after partial capture\r\n- \"Settlement\", \"SettlementFee\", \"SettlementRefund\": Provider settlement transactions\r\n- \"Bookkeeping\", \"CreditBookkeeping\": Internal accounting transactions\r\n- \"Other\": Other transaction types\r\n \r\nFor POS/in-store sales, use \"Sale\" since payment is captured immediately at point of sale.\r\nFor e-commerce orders, use \"Authorization\" - Omnium workflows handle Capture, Credit, and Void automatically.", "nullable": true }, "validationCode": { "type": "string", "description": "Deprecated. Not in use.", "nullable": true, "deprecated": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for provider-specific data or additional metadata.\r\nCan store any key-value pairs needed for the payment integration.", "nullable": true }, "paidDate": { "type": "string", "description": "The original date when the payment was made.\r\nMay differ from Created if the payment was pre-paid or processed externally before registration.", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "Timestamp when this payment record was created/registered in Omnium.", "format": "date-time", "nullable": true }, "isManuallyAdded": { "type": "boolean", "description": "Indicates if this payment was manually added through the Omnium UI rather than from a payment provider integration.\r\nManual payments are typically used for cash, bank transfer, or other offline payment methods." }, "comment": { "type": "string", "description": "Free-text comment or note about the payment.\r\nUseful for manual payments or special circumstances.", "nullable": true }, "internalReference": { "type": "string", "description": "Internal reference for linking this payment to other business documents.\r\nCan be used for RMA numbers, related order numbers, or other cross-references.", "nullable": true }, "reason": { "type": "string", "description": "Description or reason for the payment, especially useful for refunds/credits.\r\nExample: \"Return of damaged item\", \"Partial refund for shipping delay\"", "nullable": true }, "authorizationExpires": { "type": "string", "description": "Expiration date/time for the authorization from the payment provider.\r\nAfter this date, the authorization may no longer be valid for capture.\r\nImportant for managing capture timing and avoiding authorization expiry.", "format": "date-time", "nullable": true }, "storeId": { "type": "string", "description": "The store or warehouse ID associated with this payment.\r\nUsed for multi-store scenarios where payments need to be attributed to specific locations.", "nullable": true }, "shipmentId": { "type": "string", "description": "The shipment ID this payment is associated with.\r\nUsed when payments are split across multiple shipments or for shipment-specific captures.", "nullable": true }, "invoiceId": { "type": "string", "description": "Reference to an invoice if this payment is linked to an invoice document.\r\nUsed for invoice-based payment methods or accounting integrations.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external system identifiers for this payment.\r\nUseful for linking the payment to records in ERP, accounting, or other external systems.", "nullable": true }, "orderLineReferences": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentOrderLineReference" }, "description": "References to order line items associated with this payment.\r\nUsed to correlate credit/refund payments with specific line items, e.g., on return orders.", "nullable": true }, "reservationId": { "type": "string", "description": "Reference from some payment providers where transaction id diff from a reservation/auth", "nullable": true } }, "additionalProperties": false, "description": "Represents a payment transaction on an order or cart.\r\nEach payment record represents a single transaction with a payment provider.\r\nAn order can have multiple payments (e.g., partial payment with gift card + credit card).\r\n \r\nPayment flow:\r\n1. Customer completes checkout in your storefront\r\n2. Frontend initiates payment with the provider (Klarna, Vipps, etc.)\r\n3. Provider returns transaction details (TransactionId, Amount, Status)\r\n4. Frontend calls Omnium API to register the payment on the cart\r\n5. Cart is placed as an order\r\n6. Omnium can later capture, refund, or void the payment through the provider\r\n \r\nMultiple payments: When an order has multiple payments (e.g., gift card + Klarna),\r\nthey are processed in the order they appear in the payments list." }, "OmniumPaymentFilters": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "description": "Id", "nullable": true }, "transactionIds": { "type": "array", "items": { "type": "string" }, "description": "Payment ID from provider", "nullable": true }, "transactionTypes": { "type": "array", "items": { "type": "string" }, "description": "Transaction type, e.g. \"Authorization\", \"Capture\", \"Credit\", etc...", "nullable": true }, "paymentMethodNames": { "type": "array", "items": { "type": "string" }, "description": "Payment method name", "nullable": true }, "statuses": { "type": "array", "items": { "type": "string" }, "description": "Payment status, e.g. \"Processed\", \"Failed\"", "nullable": true } }, "additionalProperties": false, "description": "Payment transaction filters - Specified filters for selecting one or more payments" }, "OmniumPaymentOption": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the payment option/provider", "nullable": true }, "paymentMethodName": { "type": "string", "description": "Unique name to identify this payment option.", "nullable": true }, "providerName": { "type": "string", "description": "Unique name to identify this payment option if PaymentMethodName needs to be something special. If Payment provider(klarna) has two\r\ndifferent payment types, ProviderName should be same on both, and PaymentMethodName can differ", "nullable": true }, "displayName": { "type": "string", "description": "Friendly name for payment option", "nullable": true }, "merchantId": { "type": "string", "description": "Provider id", "nullable": true }, "apiToken": { "type": "string", "description": "Provider token", "nullable": true }, "clientId": { "type": "string", "description": "Provider ClientId/key", "nullable": true }, "baseUrl": { "type": "string", "description": "Url to payment provider", "nullable": true }, "authorizationBaseUrl": { "type": "string", "description": "Url to authorization(if differ from BaseUrl) payment provider", "nullable": true }, "logoUrl": { "type": "string", "description": "Provider logo url", "nullable": true }, "isEmptyPayment": { "type": "boolean", "description": "Used if this is dummy provider(not going to 3 party)" }, "displayInCart": { "type": "boolean", "description": "Visible in a cart/checkout" }, "editable": { "type": "boolean", "description": "Possible to change props" }, "termsUrl": { "type": "string", "description": "Url to website payment terms", "nullable": true }, "authorizationTimeInDays": { "type": "integer", "description": "Default expiration time in days for authorization amount", "format": "int32" } }, "additionalProperties": false, "description": "Class for diffenret payment options" }, "OmniumPaymentOrderLineReference": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "The line item ID this payment is associated with.", "nullable": true } }, "additionalProperties": false, "description": "References an order line item associated with a payment.\r\nUsed to correlate credit/refund payments with specific line items on return orders." }, "OmniumPaymentPatch": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total payment amount", "format": "decimal", "nullable": true }, "authorizationCode": { "type": "string", "description": "Payment provider authorization code / transaction id", "nullable": true }, "customerName": { "type": "string", "description": "Name of customer", "nullable": true }, "id": { "type": "string", "description": "Unique for each transaction", "nullable": true }, "paymentMethodId": { "type": "string", "description": "Payment GUID", "format": "uuid", "nullable": true }, "paymentMethodName": { "type": "string", "description": "Provider ID", "nullable": true }, "paymentType": { "type": "string", "description": "Payment type e.g. \"Invoice\", \"\"", "nullable": true }, "status": { "type": "string", "description": "Payment status", "nullable": true }, "transactionId": { "type": "string", "description": "Payment ID for provider", "nullable": true }, "transactionType": { "type": "string", "description": "Transaction type, e.g. \"Authorization\", \"Capture\", \"Credit\", etc...", "nullable": true }, "validationCode": { "type": "string", "description": "Not in use", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "paidDate": { "type": "string", "description": "Original date of payment. Could differ from \"Created\" if it has been pre-paid for instance", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "When the payment was created/registered", "format": "date-time", "nullable": true }, "isManuallyAdded": { "type": "boolean", "description": "If user added payment transaction in gui, not from provider", "nullable": true }, "comment": { "type": "string", "description": "Comment", "nullable": true }, "internalReference": { "type": "string", "description": "Internal reference (RMA number, order number, etc)", "nullable": true }, "reason": { "type": "string", "description": "Description / reason for the payment", "nullable": true }, "authorizationExpires": { "type": "string", "description": "Date from external payment provider when payment will expire (for capture)", "format": "date-time", "nullable": true }, "storeId": { "type": "string", "description": "StoreId/WarehouseId for this transaction", "nullable": true }, "shipmentId": { "type": "string", "description": "ShipmentId for this transaction", "nullable": true }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External IDs", "nullable": true } }, "additionalProperties": false, "description": "Payment transaction" }, "OmniumPaymentRefund": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the payment method used for refund.", "nullable": true }, "amount": { "type": "number", "description": "Total amount refunded through this payment method.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of refund transactions using this payment method.", "format": "int32" }, "subPayments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSubPayment" }, "description": "Breakdown of refund payment method into sub-categories (optional).", "nullable": true } }, "additionalProperties": false, "description": "Represents a payment method used for refund transactions." }, "OmniumPaymentReportSearchRequest": { "type": "object", "properties": { "createdFrom": { "type": "string", "description": "Transaction created date from", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Transaction created date to", "format": "date-time", "nullable": true }, "paidFrom": { "type": "string", "description": "Transaction paid date from", "format": "date-time", "nullable": true }, "paidTo": { "type": "string", "description": "Transaction paid date to", "format": "date-time", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Transaction store Ids", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Transaction market Ids", "nullable": true }, "paymentMethodName": { "type": "string", "description": "Payment method", "nullable": true }, "shipmentMethodName": { "type": "string", "description": "Shipment method name", "nullable": true } }, "additionalProperties": false, "description": "Search request object for payment transactions" }, "OmniumPaymentSummary": { "type": "object", "properties": { "paymentDate": { "type": "string", "description": "Payment date", "format": "date-time" }, "orderStoreId": { "type": "string", "description": "Order store id", "nullable": true }, "paymentMethod": { "type": "string", "description": "payment method", "nullable": true }, "totalInclVat": { "type": "number", "description": "Total incl VAT", "format": "decimal" }, "totalExclVat": { "type": "number", "description": "Total excl VAT", "format": "decimal" }, "totalCreditedInclVat": { "type": "number", "description": "Total credited incl VAT", "format": "decimal" }, "totalCreditedExclVat": { "type": "number", "description": "Total credited excl VAT", "format": "decimal" }, "taxRates": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentSummaryTaxRate" }, "description": "Total captured and credited per tax rate", "nullable": true } }, "additionalProperties": false, "description": "Payment summary report" }, "OmniumPaymentSummaryOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentSummary" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPaymentSummaryTaxRate": { "type": "object", "properties": { "taxRate": { "type": "number", "description": "Tax rate", "format": "decimal" }, "totalCapture": { "type": "number", "description": "Total incl VAT", "format": "decimal" }, "totalCredit": { "type": "number", "description": "Total credited incl VAT", "format": "decimal" } }, "additionalProperties": false, "description": "Payment summary for tax rate" }, "OmniumPaymentTransaction": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number", "nullable": true }, "amount": { "type": "number", "description": "Transaction amount", "format": "decimal" }, "amountExclTax": { "type": "number", "description": "Transaction amount excluding tax", "format": "decimal" }, "currencyCode": { "type": "string", "description": "Currency", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "transactionId": { "type": "string", "description": "Payment provider transaction ID", "nullable": true }, "created": { "type": "string", "description": "Payment transaction date", "format": "date-time", "nullable": true }, "transactionType": { "type": "string", "description": "Transaction type (Capture / Credit)", "nullable": true }, "reservationId": { "type": "string", "description": "Payment reservation ID", "nullable": true }, "authorizationCode": { "type": "string", "description": "Payment authorization code", "nullable": true }, "paymentMethodName": { "type": "string", "description": "Payment provider ID", "nullable": true }, "comment": { "type": "string", "description": "Payment comment", "nullable": true }, "internalReference": { "type": "string", "description": "Internal reference", "nullable": true }, "paidDate": { "type": "string", "description": "Payment Date", "format": "date-time", "nullable": true }, "transactionDate": { "type": "string", "description": "Date of transaction (In use for settlements only).", "format": "date-time", "nullable": true }, "paymentStoreId": { "type": "string", "description": "Store ID for payment transaction", "nullable": true }, "paymentStoreName": { "type": "string", "description": "Store name for payment transaction", "nullable": true }, "paymentMarketId": { "type": "string", "description": "Market ID for payment transaction", "nullable": true }, "shipmentId": { "type": "string", "description": "Shipment ID triggering transaction", "nullable": true }, "externalIds": { "type": "string", "description": "Store External IDs", "nullable": true }, "shippingLabel": { "type": "string", "description": "Shipping label", "nullable": true }, "orderCreated": { "type": "string", "description": "Order date", "format": "date-time" }, "orderTotal": { "type": "number", "description": "Order total (all payments)", "format": "decimal" }, "shippingTotal": { "type": "number", "description": "Shipping total (shipping cost)", "format": "decimal" }, "remainingPayment": { "type": "number", "description": "Remaining order payment", "format": "decimal", "nullable": true }, "billingCurrency": { "type": "string", "description": "Billing Currency", "nullable": true }, "lineItems": { "type": "integer", "description": "Number of line items on order / shipment", "format": "int32" }, "status": { "type": "string", "description": "Order / shipment status", "nullable": true }, "id": { "type": "string", "description": "Unique id for transaction", "nullable": true }, "paymentProviderFee": { "type": "number", "description": "Payment provider fee", "format": "decimal" }, "paymentNumber": { "type": "string", "description": "Payment number", "nullable": true }, "orderStoreId": { "type": "string", "description": "Store ID for the order", "nullable": true }, "orderStoreName": { "type": "string", "description": "Store name for the order", "nullable": true }, "settlementReference": { "type": "string", "description": "Settlement reference", "nullable": true }, "salesChannel": { "type": "string", "description": "Sales channel", "nullable": true }, "returnStoreId": { "type": "string", "description": "Store ID for the return.", "nullable": true } }, "additionalProperties": false, "description": "Payment transaction" }, "OmniumPaymentTransactionOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentTransaction" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPendingNotification": { "type": "object", "properties": { "notificationId": { "type": "string", "description": "Notification ID", "nullable": true }, "recipient": { "type": "string", "description": "Notification recipient", "nullable": true }, "notificationPartitionKey": { "type": "string", "description": "Notification partition key", "nullable": true }, "notificationName": { "type": "string", "description": "Notification name", "nullable": true }, "sendDate": { "type": "string", "description": "Scheduled send date", "format": "date-time" }, "notificationGroup": { "type": "string", "description": "Notification group", "nullable": true } }, "additionalProperties": false, "description": "Pending notification that should be picked up by the notification scheduler" }, "OmniumPickList": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID.", "nullable": true }, "name": { "type": "string", "description": "Name of pickList.", "nullable": true }, "modified": { "type": "string", "description": "Date pick list was modified (UTC).", "format": "date-time" }, "created": { "type": "string", "description": "Date pick list was created (UTC).", "format": "date-time" }, "warehouseCode": { "type": "string", "description": "Unique ID of warehouse.", "nullable": true }, "warehouseName": { "type": "string", "description": "Name of warehouse.", "nullable": true }, "status": { "type": "string", "description": "Status of the pick list.", "nullable": true }, "pickListOrderItems": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPickListOrderItem" }, "description": "The orders the items in this pick list appear on.", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties, key - value pairs.", "nullable": true } }, "additionalProperties": false, "description": "A pick list for retrieving items from the warehouse." }, "OmniumPickListOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPickList" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPickListOrderItem": { "type": "object", "properties": { "orderId": { "type": "string", "description": "ID of an order, .", "nullable": true }, "shipmentId": { "type": "string", "description": "Id of a shipment.", "nullable": true } }, "additionalProperties": false }, "OmniumPickListPatch": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPickListSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of orders to take.", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take]).", "format": "int32" }, "createdFrom": { "type": "string", "description": "PickLists created from date.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "PickLists created to date.", "format": "date-time", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order for the results. Defaults to created date descending. Possible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending.", "nullable": true } }, "additionalProperties": false, "description": "PickList search request." }, "OmniumPickUpPoint": { "type": "object", "properties": { "servicePointId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "routeDistance": { "type": "integer", "format": "int32" }, "routingCode": { "type": "string", "nullable": true }, "visitingAddress": { "$ref": "#/components/schemas/OmniumVisitingaddress" }, "deliveryAddress": { "$ref": "#/components/schemas/OmniumDeliveryaddress" }, "coordinate": { "$ref": "#/components/schemas/OmniumCoordinate" }, "openingHours": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOpeninghour" }, "nullable": true } }, "additionalProperties": false }, "OmniumPickUpPointAddress": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "streetName": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPickUpPointOpeningHour": { "type": "object", "properties": { "day": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPostingSource": { "enum": [ "PosZReport", "WebFulfillment" ], "type": "string", "description": "Discriminator for the source that produced an accounting posting." }, "OmniumPotentialDiscountHint": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/OmniumPotentialDiscountHintType" }, "promotionId": { "type": "string", "description": "Id of the promotion this hint relates to.", "nullable": true }, "promotionName": { "type": "string", "description": "Display name of the promotion.", "nullable": true }, "rewardPercentage": { "type": "number", "description": "Reward percentage of the promotion, when the reward is percentage-based.", "format": "decimal", "nullable": true }, "rewardUsePercentage": { "type": "boolean", "description": "True if the reward is a percentage discount; false if it is a fixed amount." }, "missingQuantity": { "type": "integer", "description": "Number of additional units required for the promotion to apply.", "format": "int32", "nullable": true }, "missingAmount": { "type": "number", "description": "Additional amount required for the promotion to apply.", "format": "decimal", "nullable": true }, "potentialSavings": { "type": "number", "description": "Estimated savings if the missing condition is met.", "format": "decimal", "nullable": true }, "currency": { "type": "string", "description": "Currency for MissingAmount and PotentialSavings.", "nullable": true }, "relatedLineItemId": { "type": "string", "description": "Id of the cart line item this hint is related to, if any.", "nullable": true }, "relatedProductId": { "type": "string", "description": "Id of a product associated with the hint (e.g. the missing kit component).", "nullable": true }, "relatedProductName": { "type": "string", "description": "Name of the related product, if any.", "nullable": true }, "relatedImageUrl": { "type": "string", "description": "Image URL of the related product, if any.", "nullable": true }, "requiredCouponCode": { "type": "string", "description": "Coupon code required for the promotion to apply, when Type is CouponRequired.", "nullable": true } }, "additionalProperties": false, "description": "A hint describing a promotion that does not currently apply to the cart but would if\r\nadditional conditions were met (more items, higher order amount, club member, coupon, etc.)." }, "OmniumPotentialDiscountHintType": { "enum": [ "MultiBuyMissingQuantity", "OrderAmountMissing", "ShippingAmountMissing", "KitMissingItems", "ClubMemberRequired", "CouponRequired" ], "type": "string", "description": "Type of potential-discount hint returned by GetPotentialDiscounts." }, "OmniumPractice": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of practice/training transactions.", "format": "int32" }, "amount": { "type": "number", "description": "Total amount of practice/training transactions (not included in financial totals).", "format": "decimal" } }, "additionalProperties": false, "description": "Represents practice or training transactions that should not be included in actual financial totals.\r\nNote: This is not a standard POS concept and may be specific to certain systems like Sitoo." }, "OmniumPrice": { "type": "object", "properties": { "marketId": { "type": "string", "description": "Market ID the price is valid in", "nullable": true }, "marketGroupId": { "type": "string", "description": "Market group ID the price is valid in", "nullable": true }, "marketType": { "type": "string", "description": "Market type for this price. B2B or B2C for instance.", "nullable": true }, "storeId": { "type": "string", "description": "Store ID the price is valid in", "nullable": true }, "storeGroupId": { "type": "string", "description": "Store group ID the price is valid in", "nullable": true }, "code": { "type": "string", "description": "The product identifier for the price", "nullable": true }, "validFrom": { "type": "string", "description": "Price available from this date", "format": "date-time" }, "validUntil": { "type": "string", "description": "Price available until this date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "When the price was last modified", "format": "date-time", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum purchase quantity for getting this price", "format": "decimal" }, "unitPrice": { "type": "number", "description": "Price for single item (after applied discounts)", "format": "decimal" }, "currencyCode": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "customerId": { "type": "string", "description": "Id for the customer if this is a customer specific price", "nullable": true }, "customerGroup": { "type": "string", "description": "Id for the customer group if this a customer group specific price", "nullable": true }, "discountAmount": { "type": "number", "description": "The amount the original price is discounted", "format": "decimal" }, "discountPercent": { "type": "number", "description": "Discount amount in percentage", "format": "decimal" }, "originalUnitPrice": { "type": "number", "description": "Original unit price (before discounts)", "format": "decimal" }, "recommendedRetailPrice": { "type": "number", "description": "Recommended retail price - to inform customers on B2B sites", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "skuId": { "type": "string", "description": "(Obsolete) - Use Code instead. Sku specific price (product is updated if SkuId is empty).", "nullable": true, "deprecated": true }, "promotionId": { "type": "string", "description": "Promotion id. Used if price is created for a promotion / campaign", "nullable": true }, "promotionName": { "type": "string", "description": "Promotion name. Used if price is create for a promotion / campaign", "nullable": true }, "promotionPriority": { "type": "integer", "description": "Promotion priority. Used if price is create for a promotion / campaign", "format": "int32", "nullable": true }, "isTaxExcluded": { "type": "boolean", "description": "If true, tax should be excluded from the unit price specified. Tax will be added in later calculations." }, "taxRate": { "type": "number", "description": "Use this taxrate if product tax differ from market default taxRate. If null, market tax rate will be used, if it has value(0, 10, 15..) this is used in calculation", "format": "decimal", "nullable": true }, "cost": { "type": "number", "description": "Product cost price", "format": "decimal" }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock" }, "isExternalPromotion": { "type": "boolean", "description": "If true, the promotion engine is external for this price, and the Omnium promotion engine will not perform any validation", "nullable": true }, "unit": { "type": "string", "description": "Type of unit the price is for", "nullable": true }, "isCustomerClubSpecificPrice": { "type": "boolean", "description": "True if price is customer club specific" }, "priceType": { "type": "string", "description": "The price type field allows the usage of special types of prices, such as a blocking price (\"B\") which can be used in combination with a customer ID. This would block the product from the customer's assortment.", "nullable": true }, "externalId": { "type": "string", "description": "Optional: If ExternalId is set, this will override the convention based ID generated by Omnium. This is useful if your prices are fetched from an external system where prices are ID based.", "nullable": true }, "productId": { "type": "string", "description": "Calculated: ProductId of product. Will only be set when using separate prices.", "nullable": true }, "priceListId": { "type": "string", "description": "Price list id. Used if price is related to a price list", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/labeling prices (e.g. \"Last Chance\", \"Clearance\").\r\nDownstream systems can use these tags for display logic.", "nullable": true }, "priceListItemId": { "type": "string", "description": "Calculated: Reference to the specific price list item that created this price", "nullable": true } }, "additionalProperties": false, "description": "Calculated: Current price (lowest available price) - property is read only, will be set by Omnium when returned to sales channels" }, "OmniumPriceDeleteRequest": { "type": "object", "properties": { "productId": { "type": "string", "description": "ProductId of the product to delete prices for. (If multiple language versions, all versions will be deleted.)", "nullable": true }, "prices": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "Prices to delete. If this is null, all prices for the given productId will be deleted. If empty list, no prices will be deleted.", "nullable": true }, "ignoreDates": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates. If false, only prices with exact same dates will be overridden." }, "ignoreValidUntilDate": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates for the \"ValidUntil\" property, but will still need an exact match for the \"ValidFrom\" property. This will only work if \"IgnoreDates\" is set to \"false\"." } }, "additionalProperties": false, "description": "Request for deleting prices" }, "OmniumPriceList": { "required": [ "currencyCode", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the price list." }, "name": { "type": "string", "description": "The name of the price list." }, "priceListType": { "$ref": "#/components/schemas/OmniumPriceListTypeEnum" }, "priceType": { "$ref": "#/components/schemas/OmniumPriceTypeEnum" }, "marketId": { "type": "string", "description": "Identifier for the market this price list applies to (deprecated - use MarketIds or MarketGroupId instead).", "nullable": true, "deprecated": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "List of market IDs this price list applies to.\r\nReplaces MarketId for multi-market support. Mutually exclusive with MarketGroupId.", "nullable": true }, "marketGroupId": { "type": "string", "description": "Market group ID this price list applies to. All markets in the group will be included.\r\nMutually exclusive with MarketIds.", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of store IDs where this price list is applicable.\r\nLimited to a maximum of 1000 store IDs.", "nullable": true }, "currencyCode": { "type": "string", "description": "The currency code for the prices in this price list" }, "costCurrencyCode": { "type": "string", "description": "Currency code for the cost price. Defaults to the same as CurrencyCode", "nullable": true }, "costCurrencyExchangeRate": { "type": "number", "description": "The exchange rate from cost currency to the currency for the price list.\r\nIf not given, it will be calculated and set to today's exchange rate.", "format": "decimal", "nullable": true }, "customerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of customer IDs this price list applies to.\r\nLimited to a maximum of 250 customer IDs.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "List of customer groups eligible for this price list.\r\nLimited to a maximum of 250 customer groups.", "nullable": true }, "validFrom": { "type": "string", "description": "The start date and time from which the price list is valid.", "format": "date-time", "nullable": true }, "validTo": { "type": "string", "description": "The end date and time until which the price list is valid.\r\nIf null, the price list does not expire.", "format": "date-time", "nullable": true }, "costPriceValidFrom": { "type": "string", "description": "Optional start date for cost prices. Allows the buying window to differ from the selling window\r\n(e.g. a store buying stock earlier than the campaign sells). If null, ValidFrom is used.", "format": "date-time", "nullable": true }, "costPriceValidTo": { "type": "string", "description": "Optional end date for cost prices. Allows the buying window to differ from the selling window.\r\nIf null, ValidTo is used.", "format": "date-time", "nullable": true }, "storeCostPriceValidFrom": { "type": "string", "description": "Optional start date for store cost prices (only relevant when IsStoreCostPriceEnabled is true).\r\nIf null, ValidFrom is used.", "format": "date-time", "nullable": true }, "storeCostPriceValidTo": { "type": "string", "description": "Optional end date for store cost prices (only relevant when IsStoreCostPriceEnabled is true).\r\nIf null, ValidTo is used.", "format": "date-time", "nullable": true }, "unit": { "type": "string", "description": "The unit of measurement for the price list (e.g., \"KG\", \"PCS\").\r\nIMPORTANT: Only use this if price list should apply to other units than the main sales unit", "nullable": true }, "roundingDecimals": { "type": "integer", "description": "Number of decimal places to use when calculating unit price.", "format": "int32", "nullable": true }, "isCustomerClubSpecificPrice": { "type": "boolean", "description": "If the prices should be customer specific", "nullable": true }, "taxRate": { "type": "number", "description": "The tax rate for the price list. If not given, the default tax rate for the market will be set.", "format": "decimal", "nullable": true }, "isExcludingTax": { "type": "boolean", "description": "If tax should be ignored on the price list" }, "isActive": { "type": "boolean", "description": "Calculated: True if the price list is activated." }, "isPromotionsAllowed": { "type": "boolean", "description": "True if prices from the price list can be combined with promotions", "nullable": true }, "published": { "type": "string", "description": "Calculated: The time when the price list was activated", "format": "date-time", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Optional properties on the price list", "nullable": true }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "Optional external ids on the price list", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "Calculated: If something is wrong with the price list", "nullable": true }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Calculated: Modified date", "format": "date-time", "nullable": true }, "priceFactor": { "type": "number", "description": "PriceFactor and PurchaseDiscountPercentage is used to calculate 'configurable product prices. PriceFactor works as a exchange rate (with mark-up) when calculating the placed price (example SEK) from the inputted list price (NOK).", "format": "decimal", "nullable": true }, "purchaseDiscountPercentage": { "type": "number", "description": "Only relevant for configurable products when calculating cost price from inputted list price", "format": "decimal" }, "isPriceEditable": { "type": "boolean", "description": "Allow editing the calculated prices which are disabled by default" }, "useLatestExchangeRateForCost": { "type": "boolean", "description": "When enabled, the latest available currency exchange rate is always used to calculate the cost" }, "supplierId": { "type": "string", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/labeling price lists (e.g. \"Last Chance\", \"Clearance\").\r\nDownstream systems can use these tags for display logic.", "nullable": true }, "isStoreCostPriceEnabled": { "type": "boolean", "description": "Enable store cost pricing with separate market/store group dimensions" }, "storeCostPriceMarketIds": { "type": "array", "items": { "type": "string" }, "description": "Market IDs for store cost price dimension", "nullable": true }, "storeCostPriceStoreGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Store group IDs for store cost price dimension", "nullable": true }, "promotionId": { "type": "string", "description": "Reference to the owning promotion.", "nullable": true }, "isMetadataOnly": { "type": "boolean", "description": "When true, this price list contains only planning/budget metadata and does not push prices to products." } }, "additionalProperties": false, "description": "Represents a price list in the OMS." }, "OmniumPriceListItem": { "required": [ "priceListId" ], "type": "object", "properties": { "priceListId": { "type": "string", "description": "The Id of the price list this item is linked to" }, "skuId": { "type": "string", "description": "Optional: If the price list item should apply on variant level, specify the sku id.", "nullable": true }, "productId": { "type": "string", "description": "If skuId is provided, this will be calculated. If not, the priceListItem will apply on product level, and the ProductId is requred.", "nullable": true }, "unitPrice": { "type": "number", "description": "The unit price of the item", "format": "decimal" }, "cost": { "type": "number", "description": "The cost price in cost currency", "format": "decimal" }, "costInPriceListCurrency": { "type": "number", "description": "Calculated: The cost price in the price lists currency", "format": "decimal" }, "costCurrencyCode": { "type": "string", "description": "Optional per-item override for the cost currency. When set, the price-list-level cost currency is ignored for this item.\r\nIf provided without CostCurrencyExchangeRate, the rate is resolved server-side via the currency service.", "nullable": true }, "costCurrencyExchangeRate": { "type": "number", "description": "Optional per-item override for the cost currency exchange rate to the price list currency.\r\nWhen omitted but CostCurrencyCode is set, the rate is resolved server-side via the currency service.", "format": "decimal", "nullable": true }, "name": { "type": "string", "description": "Name of the price list item", "nullable": true }, "created": { "type": "string", "description": "Time the item was created", "format": "date-time", "nullable": true }, "discount": { "type": "number", "description": "The discount for the price list item", "format": "decimal" }, "discountPercent": { "type": "number", "description": "Calculated: The given discount in percentage", "format": "decimal" }, "discountedPrice": { "type": "number", "description": "Calculated: UnitPrice - Discount", "format": "decimal" }, "profit": { "type": "number", "description": "Calculated: UnitPriceExTax - CostInPriceListCurrency", "format": "decimal" }, "profitPercent": { "type": "number", "description": "Calculated: Profit/Cost", "format": "decimal" }, "profitMargin": { "type": "number", "description": "Calculated: Profit/UnitPriceExTax", "format": "decimal" }, "isActive": { "type": "boolean", "description": "Calculated: True if the price is activated for the sku. Is set to active when price list is activated.", "nullable": true }, "id": { "type": "string", "description": "Calculated: {PricelistId}_{SkuId}", "nullable": true }, "taxRate": { "type": "number", "description": "Optional tax rate override for this item. If null, the price list's tax rate is used.\r\nUseful when specific products have a different tax rate than the price list default (e.g. 0% for used goods).", "format": "decimal", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/labeling price list items (e.g. \"Last Chance\", \"Clearance\").\r\nDownstream systems can use these tags for display logic.", "nullable": true }, "costDiscount": { "type": "number", "description": "Cost discount amount", "format": "decimal" }, "costDiscountPercent": { "type": "number", "description": "Calculated: Cost discount as percentage", "format": "decimal" }, "discountedCost": { "type": "number", "description": "Calculated: Cost after discount", "format": "decimal" }, "unitPriceBase": { "type": "number", "description": "Calculated: Base unit price before adjustments", "format": "decimal" }, "storeCostPrice": { "type": "number", "description": "Store cost price in price list currency", "format": "decimal" }, "storeDiscountedCostPrice": { "type": "number", "description": "Calculated: Store discounted cost price", "format": "decimal" }, "storeCostPriceAdditionPercent": { "type": "number", "description": "Addition percentage on discounted cost to derive store cost price", "format": "decimal" }, "storeCostPriceMargin": { "type": "number", "description": "Store margin: (DiscountedPrice - StoreCostPrice) / DiscountedPrice * 100", "format": "decimal" }, "product": { "$ref": "#/components/schemas/OmniumPriceListItemProduct" }, "standardCost": { "type": "number", "description": "Standard cost in cost currency. User-settable via public API.", "format": "decimal", "nullable": true }, "standardCostInPriceListCurrency": { "type": "number", "description": "Standard cost in price list currency. Recomputed by the server from StandardCost x CostCurrencyExchangeRate; values set by the caller are overwritten.", "format": "decimal", "nullable": true }, "discountedStandardCost": { "type": "number", "description": "Standard cost reduced by the absolute CostDiscount amount. Does not factor in CostDiscountPercent. Calculated server-side; values set by the caller are ignored.", "format": "decimal", "nullable": true }, "discountedStandardCostInPriceListCurrency": { "type": "number", "description": "Discounted standard cost in price list currency. Calculated server-side from the absolute CostDiscount; values set by the caller are ignored.", "format": "decimal", "nullable": true }, "plannedSalesVolume": { "type": "number", "description": "Planned sales volume (units) - primary planning input", "format": "decimal", "nullable": true }, "plannedRevenue": { "type": "number", "description": "Planned revenue calculated from PlannedSalesVolume x DiscountedPrice", "format": "decimal", "nullable": true }, "planningComment": { "type": "string", "description": "Optional internal comment for planning context", "nullable": true }, "plannedPurchaseVolume": { "type": "number", "description": "Planned purchase volume (units) - expected purchasing quantity for the campaign", "format": "decimal", "nullable": true }, "planningPurchaseComment": { "type": "string", "description": "Optional internal comment for purchase planning context", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for this price list item", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "Validation errors and warnings attached to this item. Populated by price list validation runs.", "nullable": true } }, "additionalProperties": false, "description": "Represents an individual item in a price list within the OMS" }, "OmniumPriceListItemOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceListItem" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPriceListItemPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the price list item to patch. Format: {PriceListId}_{SkuId} or {PriceListId}_{ProductId}.\r\nCan be omitted if PriceListId and SkuId/ProductId are provided separately.", "nullable": true }, "priceListId": { "type": "string", "description": "The price list this item belongs to. Used together with SkuId or ProductId to derive the Id when Id is not set.", "nullable": true }, "skuId": { "type": "string", "description": "The SKU identifier. Used together with PriceListId to derive the Id when Id is not set.", "nullable": true }, "productId": { "type": "string", "description": "The product identifier. Used together with PriceListId to derive the Id when Id is not set. SkuId takes precedence if both are provided.", "nullable": true }, "name": { "type": "string", "description": "Name of the price list item", "nullable": true }, "unitPrice": { "type": "number", "description": "The unit price of the item", "format": "decimal", "nullable": true }, "cost": { "type": "number", "description": "The cost price in cost currency", "format": "decimal", "nullable": true }, "costCurrencyCode": { "type": "string", "description": "Optional per-item override for the cost currency. When set, the price-list-level cost currency is ignored for this item.\r\nIf provided without CostCurrencyExchangeRate, the rate is resolved server-side via the currency service.", "nullable": true }, "costCurrencyExchangeRate": { "type": "number", "description": "Optional per-item override for the cost currency exchange rate to the price list currency.\r\nWhen omitted but CostCurrencyCode is set, the rate is resolved server-side via the currency service.", "format": "decimal", "nullable": true }, "standardCost": { "type": "number", "description": "Standard cost in cost currency.", "format": "decimal", "nullable": true }, "standardCostInPriceListCurrency": { "type": "number", "description": "Standard cost in price list currency. Recomputed by the server from StandardCost x CostCurrencyExchangeRate; values set by the caller are overwritten.", "format": "decimal", "nullable": true }, "discount": { "type": "number", "description": "The absolute discount amount for the price list item, in price list currency.\r\nDiscount, DiscountPercent and DiscountedPrice are three ways to express the same discount.\r\nWhen more than one is supplied, the absolute Discount takes precedence, then DiscountPercent, then DiscountedPrice.\r\nAny of the three you omit is reset (it is not carried over from the stored value), so the supplied field alone drives the result.", "format": "decimal", "nullable": true }, "discountPercent": { "type": "number", "description": "The discount expressed as a percentage of UnitPrice (e.g. 20 for 20%).\r\nSee Omnium.Public.PriceLists.OmniumPriceListItemPatch.Discount for how it interacts with Discount and DiscountedPrice.", "format": "decimal", "nullable": true }, "discountedPrice": { "type": "number", "description": "The resulting price after discount, in price list currency. Must be less than UnitPrice to register a discount.\r\nSee Omnium.Public.PriceLists.OmniumPriceListItemPatch.Discount for how it interacts with Discount and DiscountPercent.", "format": "decimal", "nullable": true }, "costDiscount": { "type": "number", "description": "Cost discount amount", "format": "decimal", "nullable": true }, "storeCostPrice": { "type": "number", "description": "Store cost price in price list currency. Bidirectional with StoreCostPriceAdditionPercent — if one is set, the other is derived.", "format": "decimal", "nullable": true }, "storeCostPriceAdditionPercent": { "type": "number", "description": "Addition percentage on discounted cost to derive store cost price. Bidirectional with StoreCostPrice — if one is set, the other is derived.", "format": "decimal", "nullable": true }, "taxRate": { "type": "number", "description": "Optional tax rate override for this item. If null, the price list's tax rate is used.\r\nSet to a value (e.g. 0, 12, 25) to override, or omit to leave unchanged.", "format": "decimal", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for categorizing/labeling price list items (e.g. \"Last Chance\", \"Clearance\").", "nullable": true }, "plannedSalesVolume": { "type": "number", "description": "Planned sales volume (units) - primary planning input", "format": "decimal", "nullable": true }, "plannedRevenue": { "type": "number", "description": "Planned revenue calculated from PlannedSalesVolume x DiscountedPrice", "format": "decimal", "nullable": true }, "planningComment": { "type": "string", "description": "Optional internal comment for planning context", "nullable": true }, "plannedPurchaseVolume": { "type": "number", "description": "Planned purchase volume (units) - expected purchasing quantity for the campaign", "format": "decimal", "nullable": true }, "planningPurchaseComment": { "type": "string", "description": "Optional internal comment for purchase planning context", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for this price list item", "nullable": true } }, "additionalProperties": false, "description": "Partial update model for a price list item. Only non-null fields will be applied." }, "OmniumPriceListItemPatchUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "createdCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "notFoundIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true }, "isModified": { "type": "boolean" } }, "additionalProperties": false }, "OmniumPriceListItemProduct": { "type": "object", "properties": { "supplierId": { "type": "string", "description": "The supplier id from the product", "nullable": true }, "costCurrency": { "type": "string", "description": "The cost currency from the product", "nullable": true }, "brand": { "type": "string", "description": "The brand from the product", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Highlighted custom properties from the product, as defined in product settings", "nullable": true } }, "additionalProperties": false }, "OmniumPriceListItemSearchRequest": { "type": "object", "properties": { "priceListId": { "type": "string", "description": "Price list ID", "nullable": true }, "priceListIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Price list IDs", "nullable": true }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take]).", "format": "int32" }, "take": { "type": "integer", "description": "Number of items to take.", "format": "int32" }, "searchText": { "type": "string", "description": "Free text search", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order for the results. Defaults to created date descending. Possible values: CreatedAscending,", "nullable": true }, "scrollSize": { "type": "integer", "description": "Optional: The number of items returned for each scroll request. Default value is 1000. Max is 20000 and minimum is 500.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Price list item search request." }, "OmniumPriceListOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceList" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPriceListSearchRequest": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take]).", "format": "int32" }, "take": { "type": "integer", "description": "Number of items to take.", "format": "int32" }, "searchText": { "type": "string", "description": "Free text search", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order for the results. Defaults to created date descending. Possible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, NameAscending, NameDescending, MarketAscending, MarketDescending, CurrencyAscending, CurrencyDescending.", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Store ID filter", "nullable": true }, "currencyCodes": { "type": "array", "items": { "type": "string" }, "description": "Currency filter", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Market filter", "nullable": true }, "marketGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Market group filter", "nullable": true }, "includeEmptyMarketId": { "type": "boolean", "description": "If true, price lists with empty market IDs are returned" }, "includeEmptyStoreIds": { "type": "boolean", "description": "If true, price lists with empty store IDs are returned" }, "supplierIds": { "type": "array", "items": { "type": "string" }, "description": "Supplier filter", "nullable": true }, "isActive": { "type": "boolean", "description": "If true, only active price lists are returned.", "nullable": true } }, "additionalProperties": false, "description": "Price list search request" }, "OmniumPriceListTypeEnum": { "enum": [ "Price", "CostPrice", "PriceAndCostPrice" ], "type": "string", "description": "The price list can be used to populate only prices, only cost prices or both. The default value is Price." }, "OmniumPriceOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPriceReference": { "type": "object", "properties": { "currencyCode": { "type": "string", "nullable": true }, "marketId": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "promotionId": { "type": "string", "nullable": true }, "priceListId": { "type": "string", "nullable": true }, "promotionName": { "type": "string", "nullable": true }, "unitPrice": { "type": "number", "format": "decimal" }, "isCurrentPrice": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OmniumPriceSearchRequest": { "type": "object", "properties": { "lastModified": { "type": "string", "description": "Set LastModified to a specific DateTime to get items only modified after that time", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "Filter prices on customer ID", "nullable": true }, "customerGroupId": { "type": "string", "description": "Filter prices on Customer Group ID", "nullable": true }, "marketId": { "type": "string", "description": "Filter prices on market ID", "nullable": true, "deprecated": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Filter prices on one or more market IDs. A price matches if its market ID is any of the provided values.\r\nTakes precedence over the obsolete MarketId.", "nullable": true }, "productCodes": { "maxLength": 20000, "type": "array", "items": { "type": "string" }, "description": "Filter prices on product codes (SKU / Product ID)", "nullable": true }, "priceType": { "type": "string", "description": "Filter prices on price type", "nullable": true }, "scrollSize": { "type": "integer", "description": "Optional: The number of items returned for each scroll request. Default value is 1000. Max is 20000 and minimum is 500.", "format": "int32", "nullable": true }, "unit": { "type": "string", "description": "Filter prices on unit", "nullable": true }, "isCustomerSpecificPrice": { "type": "boolean", "description": "Filter prices by customer specific prices.\r\nSet to 'true' to get only customer specific prices. Set to 'false' to get prices that are not customer specific. If not assigned, no customer filtering will be applied.", "nullable": true }, "validFrom": { "type": "string", "description": "Only return prices that are valid from this point in time, i.e. prices whose ValidFrom is on or before this value (prices without a ValidFrom are always included).\r\nCombine with ValidUntil set to the same timestamp to get prices valid at a single moment. If not set, no start-of-validity filtering is applied.", "format": "date-time", "nullable": true }, "validUntil": { "type": "string", "description": "Only return prices that are still valid at this point in time, i.e. prices whose ValidUntil is on or after this value (prices without a ValidUntil never expire and are always included).\r\nCombine with ValidFrom set to the same timestamp to get prices valid at a single moment. If not set, no end-of-validity filtering is applied.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Contains all parameters for doing a price search. At least one parameter must be set" }, "OmniumPriceTypeEnum": { "enum": [ "Default", "PriceFactor" ], "type": "string" }, "OmniumPriceUpdateRequest": { "type": "object", "properties": { "prices": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "Prices to update", "nullable": true }, "productId": { "type": "string", "description": "ProductId of the product to update. (If multiple language versions, all versions will be updated.)", "nullable": true }, "ignoreDates": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates. If false, only prices with exact same dates will be overridden." }, "ignoreValidUntilDate": { "type": "boolean", "description": "If true, prices for variant will replace existing prices with other dates for the \"ValidUntil\" property, but will still need an exact match for the \"ValidFrom\" property. This will only work if \"IgnoreDates\" is set to \"false\"." }, "pricesMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" } }, "additionalProperties": false, "description": "Price update request" }, "OmniumPrivateCustomer": { "required": [ "customerId" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "fullName": { "type": "string", "description": "Calculated - Full name", "nullable": true, "readOnly": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "birthDate": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "discountCoupons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscountCoupon" }, "description": "Personal discount coupons", "nullable": true }, "isCustomerClubMember": { "type": "boolean", "description": "True if customer is part of customer club" }, "bonusPoints": { "type": "integer", "description": "Number of bonus points earned by customer", "format": "int32" }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for customer", "nullable": true }, "customerId": { "type": "string", "description": "Unique ID" }, "customerNumber": { "type": "string", "description": "Customer identifier - does not have to be unique for each store, etc", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Customer additional addresses", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "url": { "type": "string", "description": "Customer url", "nullable": true }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Customer favorite stores", "nullable": true }, "marketId": { "type": "string", "description": "Customer primary market", "nullable": true }, "additionalMarketIds": { "maxLength": 100, "type": "array", "items": { "type": "string" }, "description": "Additional customer markets (beyond the primary MarketId)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Customer market group", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Preferred customer language code", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Customer preferred currency code (E.g. USD, NOK, EUR)", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external customer IDs", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, customer is available in all markets / stores", "nullable": true }, "modifiedBy": { "type": "string", "description": "Name of the user or system the last modified the item", "nullable": true }, "created": { "type": "string", "description": "Date and time the customer was created", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date and time the customer was modified", "format": "date-time", "nullable": true }, "isInactive": { "type": "boolean", "description": "True if customer is inactive, and should not be able to make purchases", "nullable": true }, "preferredShippingMethod": { "type": "string", "description": "Customer's preferred shipping method name (default selected in new carts)", "nullable": true }, "paymentTerms": { "type": "string", "description": "Payment terms (free text)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (days)", "format": "int32", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Customer groups", "nullable": true }, "consents": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Customer consents", "nullable": true }, "consentHistory": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsentHistory" }, "description": "Consent history", "nullable": true }, "customerDetails": { "type": "string", "description": "Customer details (brief summary for customer service representatives)", "nullable": true }, "customerRelations": { "maxLength": 2000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerRelation" }, "description": "Related customers", "nullable": true }, "assortmentIncludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to include in customer's assortment. Only products in these categories will be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true }, "assortmentExcludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from customer's assortment. Products in these categories will not be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true } }, "additionalProperties": false, "description": "Private customer" }, "OmniumPrivateCustomerInfo": { "type": "object", "properties": { "orders": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrder" }, "description": "Customer orders", "nullable": true }, "privateCustomer": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "projects": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProject" }, "description": "Customer projects", "nullable": true } }, "additionalProperties": false, "description": "GDPR response object, containing user personal info (order, customer and project information)" }, "OmniumPrivateCustomerOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPrivateCustomerOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPrivateCustomerOmniumVersion": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/OmniumPrivateCustomer" } }, "additionalProperties": false }, "OmniumPrivateCustomerPatch": { "required": [ "customerId" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "birthDate": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "isCustomerClubMember": { "type": "boolean", "description": "True if customer is part of customer club", "nullable": true }, "bonusPoints": { "type": "integer", "description": "Number of bonus points earned by customer", "format": "int32", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for business customer", "nullable": true }, "customerId": { "type": "string", "description": "Unique ID" }, "customerNumber": { "type": "string", "description": "Customer identifier - does not have to be unique for each store, etc", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Customer additional addresses", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "url": { "type": "string", "description": "Customer url", "nullable": true }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Customer favorite stores", "nullable": true }, "marketId": { "type": "string", "description": "Customer primary market", "nullable": true }, "additionalMarketIds": { "maxLength": 100, "type": "array", "items": { "type": "string" }, "description": "Additional customer markets (beyond the primary MarketId)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Customer market group", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Preferred customer language code", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Customer preferred currency code (E.g. USD, NOK, EUR)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external customer IDs", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, customer is available in all markets / stores", "nullable": true }, "isInactive": { "type": "boolean", "description": "True if customer is inactive, and should not be able to make purchases", "nullable": true }, "preferredShippingMethod": { "type": "string", "description": "Customer's preferred shipping method name (default selected in new carts)", "nullable": true }, "paymentTerms": { "type": "string", "description": "Payment terms (free text)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (days)", "format": "int32", "nullable": true }, "customerGroups": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Customer groups", "nullable": true }, "consents": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Customer consents", "nullable": true }, "customerDetails": { "type": "string", "description": "Customer details (brief summary for customer service representatives)", "nullable": true }, "customerRelations": { "maxLength": 2000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerRelation" }, "description": "Related customers", "nullable": true } }, "additionalProperties": false, "description": "Private customer patch request" }, "OmniumPrivateCustomerViewModel": { "type": "object", "properties": { "privateCustomer": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "customerClubMember": { "$ref": "#/components/schemas/OmniumCustomerClubMember" } }, "additionalProperties": false, "description": "Info about customer and customer club membership" }, "OmniumProduct": { "type": "object", "properties": { "isSku": { "type": "boolean", "description": "True if product is stock keeping unit / product that can be sold.\r\nShould always be set to true for products without variants and false for products with variants." }, "parentId": { "type": "string", "description": "The ParentId should only be set for products that has a third product level, which is above product and variant.\r\nFor instance, if you have a product 'Awesome Sweater' that comes in 5 colors which each has 3 sizes, you should store this as five products with three variants each.\r\nYou could then populate 'ParentId' in order to group the five products together.", "nullable": true }, "variants": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "List of variants", "nullable": true }, "isLocalProduct": { "type": "boolean", "description": "Only relevant when IsLocalProductsEnabled is enabled in productSettings. When enabled, both 'IsLocalProduct' must be activated and the user must have access to a selected store in order to edit the product", "nullable": true }, "id": { "type": "string", "description": "Required for products: Product unique ID. If your product catalog has multiple languages, the ID should be set with the following convention {ProductId}_{Language} ('12345_en').\r\nFor variants, the ID will be populated from SkuID, and should not be set manually.\r\nValid format: Only letters (a-z, A-Z), digits (0-9), hyphens (-), and underscores (\\_).\r\nRegex pattern: ^[a-zA-Z0-9\\-_]+$", "nullable": true }, "skuId": { "type": "string", "description": "Product unique SKU (but equal for all language versions). This should only be set for variants, or if the product itself is sellable and is stored with 'IsSku=true' and has no variants.", "nullable": true }, "ean": { "type": "string", "description": "EAN code", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN codes", "nullable": true }, "productId": { "type": "string", "description": "Unique product Id, without language conventions.\r\nVariants on a product should have the same value for ProductId as the product has.", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "productGroup": { "$ref": "#/components/schemas/OmniumProductGroup" }, "startDate": { "type": "string", "description": "Product activation date. Product is not active if date is in the future.\r\nObsolete - Use Published property instead", "format": "date-time", "deprecated": true }, "endDate": { "type": "string", "description": "Product activation end date. Product is not active if date is in the past.\r\nObsolete - Use StopPublished property instead", "format": "date-time", "deprecated": true }, "created": { "type": "string", "description": "Date product is created", "format": "date-time" }, "modified": { "type": "string", "description": "Date product is modified", "format": "date-time" }, "published": { "type": "string", "description": "Date product is published", "format": "date-time" }, "stopPublished": { "type": "string", "description": "Product activation end date. Can be null", "format": "date-time", "nullable": true }, "discontinued": { "type": "string", "description": "Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "True if product is active. False if it should be hidden from customers." }, "catalog": { "type": "string", "description": "Label to categorize or group products. In Omnium this is used to show statistics grouped by this label. (This property is unrelated to the category tree.)", "nullable": true }, "mainCategoryId": { "type": "string", "description": "This is the main category for the product, and should be one of the CategoryIds in Categories. If Catalog is not used, this category's name will be used as grouping in statistics. If the main category is missing from the category list, it will automatically be added.", "nullable": true }, "mainCategoryName": { "type": "string", "description": "Calculated field: If MainCategoryId is given, and exists as a category in Omnium, this property will be overwritten by the name of that category.", "nullable": true }, "categories": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories. If category enrichment is turned on, only CategoryId are required when adding or updating products. The other information will be populated from the already existing category with the same id.", "nullable": true }, "mainImageUrl": { "type": "string", "description": "Product main image url. If not set, this will be populated from the product assets, using the asset which has 'IsMainImage=\"true\"' set. If none are set, the first asset in the list is selected.", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product media files", "nullable": true }, "seoInformation": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "description": "Product information for search engine optimization\r\nObsolete - Use SeoInfo instead", "nullable": true, "deprecated": true }, "seoInfo": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "entryType": { "type": "string", "description": "Product entry type", "nullable": true, "deprecated": true }, "isBundle": { "type": "boolean", "description": "True if product is a bundle of other products (unlike package, price is sum of components)" }, "isKit": { "type": "boolean", "description": "True if product is a pre-assembled kit made of other products (unlike package and bundle, kits have inventory)" }, "isPackage": { "type": "boolean", "description": "True if product is package of other products (unlike bundle, price is specified for package)" }, "isWriteProtected": { "type": "boolean", "description": "True if product is write protected by user. PIM integrations should not override product information." }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "A list of errors (or warnings) for the product.\r\nTypically this is used in integrations where there was a problem export products. The errors are searchable and displayed in Omnium's UI", "nullable": true }, "isInStock": { "type": "boolean", "description": "Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes." }, "availableInventory": { "type": "number", "description": "Calculated: Number of items available in stock. If this is a product with variants, it will be a sum of all variants.\r\nThis is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.", "format": "decimal" }, "inventory": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductInventory" }, "description": "Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.\r\nThe inventory list contains inventory information for each warehouse(store) defined in Omnium", "nullable": true }, "inventoryStatus": { "type": "string", "description": "Status of current inventory, based on AvailableInventory. Could be 'OutOfStock', 'LowInStock' or 'HighInStock'", "nullable": true }, "omniStock": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Calculated: List of store IDs where this product is available online (has stock and meets business rules for online sales)", "nullable": true }, "omniStockLevels": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOmniStockLevel" }, "description": "Calculated: Stock levels per store, used for online availability.", "nullable": true }, "warehouseInventories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumWarehouseInventory" }, "description": "Warehouse inventories\r\nObsolete - Use Inventory api endpoint instead", "nullable": true, "deprecated": true }, "catalogNodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Catalog nodes/categories. Simple list of strings of category names. Consider using the Categories property instead as this also contains IDs and category metadata.", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity (point of reordering)", "format": "decimal", "deprecated": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity (what should be in stock after new supply)", "format": "decimal", "deprecated": true }, "weight": { "type": "number", "description": "Product weight in kilograms (kg)", "format": "double", "nullable": true }, "taxCategory": { "type": "string", "description": "Product tax category", "nullable": true, "deprecated": true }, "taxGroupCode": { "type": "string", "description": "References a TaxGroup.Code in the tenant's chart of tax groups.\r\nWhen null, the tenant's DefaultTaxGroupCode applies (if feature is enabled).\r\nHas no effect when AccountingSettings.TaxGroupsEnabled = false.", "nullable": true }, "taxRate": { "type": "number", "description": "Per-product VAT rate used as a fallback when tax groups are not configured.\r\nApplied to any price that has no TaxRate of its own at save time.\r\nTax-group resolution takes precedence when enabled.", "format": "decimal", "nullable": true }, "siblings": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of sibling product IDs\r\nObsolete - Use RelatedProducts instead", "nullable": true, "deprecated": true }, "associatedProducts": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Associated product IDs\r\nObsolete - Use RelatedProducts instead", "nullable": true, "deprecated": true }, "price": { "$ref": "#/components/schemas/OmniumPrice" }, "prices": { "maxLength": 3000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of all product prices - all currencies, campaigns, customer prices etc", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of tags.", "nullable": true }, "marketIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "List of available market IDs. If not set, the product will be available for all markets.", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available store IDs. If not set, the product will be available for all stores.", "nullable": true }, "marketGroupIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available market group IDs", "nullable": true }, "language": { "type": "string", "description": "Product language code. This should match 'ProductContentLanguage' on a stored market in Omnium. Typically the values would be 'en' (english) or 'no' (norwegian).", "nullable": true }, "location": { "type": "string", "description": "The location of the product in the warehouse.", "nullable": true }, "color": { "type": "string", "description": "Product color", "nullable": true }, "brand": { "type": "string", "description": "Product brand", "nullable": true }, "size": { "type": "string", "description": "Product size", "nullable": true }, "shortDescription": { "type": "string", "description": "Short product description", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true }, "specification": { "type": "string", "description": "Product Specification", "nullable": true }, "averageRating": { "type": "number", "description": "Calculated - Average rating for this product", "format": "double" }, "ratingCount": { "type": "integer", "description": "Calculated - Number of ratings for this product", "format": "int32" }, "isNotRatable": { "type": "boolean", "description": "Set to true if this product should be excluded from rating emails/forms", "nullable": true }, "excludeFromPromotions": { "type": "boolean", "description": "Set to true if this product should be excluded from promotions", "nullable": true }, "salesStartDate": { "type": "string", "description": "Embargo date: product cannot be sold before this date", "format": "date-time", "nullable": true }, "fixedPriceCode": { "type": "string", "description": "Price protection category (e.g. book law)", "nullable": true }, "fixedPriceEndDate": { "type": "string", "description": "Discounts are blocked until this date", "format": "date-time", "nullable": true }, "discountBlocked": { "type": "boolean", "description": "Permanent discount prohibition", "nullable": true }, "isExcludedFromAnalytics": { "type": "boolean", "description": "Set to true if this product should be excluded from analytics (e.g., gift cards that would inflate sales figures)" }, "supplierName": { "type": "string", "description": "Name of main product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Main supplier ID", "nullable": true }, "supplierColor": { "type": "string", "description": "Color from supplier", "nullable": true }, "supplierPackagingUnit": { "type": "string", "description": "Unit for supplier sku", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity (D-Pack)", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "additionalSuppliers": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductSupplier" }, "description": "List of additional suppliers", "nullable": true }, "leadTime": { "type": "integer", "description": "Lead time in days", "format": "int32", "nullable": true }, "supplierLeadTime": { "type": "integer", "description": "Supplier lead time in days", "format": "int32", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier, used when creating purchase orders", "nullable": true }, "freightClass": { "type": "string", "description": "Freight class", "nullable": true }, "sizeType": { "type": "string", "description": "Product size type", "nullable": true }, "unit": { "type": "string", "description": "Product unit, used for describing what unit the quantities are in", "nullable": true }, "units": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductUnit" }, "description": "List of additional units", "nullable": true }, "colli": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductColli" }, "description": "List of colli, used for shipment", "nullable": true }, "relatedProducts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProduct" }, "description": "Related products", "nullable": true }, "season": { "type": "string", "description": "Product season", "nullable": true }, "badges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductBadge" }, "description": "List of product badges or labels to display on product", "nullable": true }, "sortIndex": { "type": "integer", "description": "Calculated sort index", "format": "int32", "readOnly": true }, "sortIndexBoost": { "type": "integer", "description": "Sort index set by API / GUI", "format": "int32" }, "sortIndexBase": { "type": "integer", "description": "Calculated sort index base set by Omnium services", "format": "int32" }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock" }, "isPriceLocked": { "type": "boolean", "description": "When true, the price on order lines created from this product will be locked and not recalculated." }, "isMainProductVariant": { "type": "boolean", "description": "If true, this variant should represent the product in flattened variant lists.\r\nThis can also be used if you have a product catalog with multiple products with the same parent ID set, and you only wish to show one of the products in product searches. You could then set this to 'false' on the products you wish to exclude from searches,\r\nand filter on the value." }, "isSerializableProduct": { "type": "boolean", "description": "If true, the product is serializable, and order line should contain serial number when completed" }, "isRental": { "type": "boolean", "description": "If true, the product is available for rental" }, "rentalSourceProductId": { "type": "string", "description": "The SKU ID of the original product this rental product was created from", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name", "nullable": true }, "popularityStandardSortIndex": { "$ref": "#/components/schemas/OmniumCustomSortIndex" }, "popularitySortIndices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomSortIndex" }, "description": "Calculated: List of market specific popularity indices", "nullable": true }, "cost": { "type": "number", "description": "Product net cost", "format": "decimal" }, "costCurrency": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "costInDefaultCurrency": { "type": "number", "description": "Cost in default currency", "format": "decimal", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components (used when product is a package)", "nullable": true }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOption" }, "description": "Available product options for the product", "nullable": true }, "productType": { "type": "string", "description": "Optional: Specifies if this product is of a specific kind.\r\nAn example of this is the type \"ProductOption\"\r\nA Product Option is a sold as an additional item or service to an other product, and is not sold by itself.\r\nInscriptions or other types of customization could be this sort of option.\r\nIt could also be a service, such as assembling, or it could be an additional item which would not make sense so sell on it's own", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotions associated with the product", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external product IDs. Could be ids in eCommerce platform etc", "nullable": true }, "locationOverstock": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Overstock locations (extra inventory locations)", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Virtual products will not affect inventory.", "nullable": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "countryOfOrigin": { "type": "string", "description": "Country of origin", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the product", "nullable": true }, "lowestPriceHistory": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceReference" }, "description": "Price history (lowest prices for each market)", "nullable": true }, "assortmentCodes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAssortmentCode" }, "description": "Assortment codes for the product", "nullable": true }, "expectedDeliveryDate": { "type": "string", "description": "Date when the product is expected back in stock. Calculated by purchase order services, or set externally.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "Status is set by Omnium. \"Published\" is default. When delete a product in GUI. Status will be updated to \"Deleted\"", "nullable": true }, "completionStatus": { "$ref": "#/components/schemas/OmniumCompletionStatus" } }, "additionalProperties": false, "description": "" }, "OmniumProductAlertRequest": { "required": [ "skuId" ], "type": "object", "properties": { "id": { "type": "string", "description": "ProductAlert ID (Will be set to Guid if not set)", "nullable": true }, "skuId": { "type": "string", "description": "SkuID of the product to alert on" }, "email": { "type": "string", "description": "Email address to send the alert to", "nullable": true }, "phone": { "type": "string", "description": "Phone number to send the alert to", "nullable": true }, "storeId": { "type": "string", "description": "StoreID of the store to monitor inventory for, if not set, will monitor all warehouses.", "nullable": true }, "marketId": { "type": "string", "description": "MarketId determines language variant of the notification.", "nullable": true } }, "additionalProperties": false }, "OmniumProductAlertSearchRequest": { "type": "object", "properties": { "id": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Id of the ProductAlert object", "nullable": true }, "skuId": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "SkuId of product", "nullable": true }, "email": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Email of the customer", "nullable": true }, "phone": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Phone number of the customer", "nullable": true }, "warehouseCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "WarehouseCodes to monitor", "nullable": true }, "storeId": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "StoreId of the original request", "nullable": true }, "storeName": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "StoreName of the original request", "nullable": true }, "isActive": { "type": "boolean", "description": "ProductAlert is active", "nullable": true }, "created": { "type": "string", "description": "Date the ProductAlert was created", "format": "date-time" }, "notificationSentDate": { "type": "string", "description": "Date the ProductAlert was sent", "format": "date-time", "nullable": true }, "productAlertDeletedDate": { "type": "string", "description": "Date the ProductAlert was deleted", "format": "date-time", "nullable": true }, "take": { "type": "integer", "description": "Number of productAlerts to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" } }, "additionalProperties": false }, "OmniumProductBadge": { "type": "object", "properties": { "type": { "type": "string", "description": "Label or badge type (Sales, Season, etc)", "nullable": true }, "text": { "type": "string", "description": "Text on badge", "nullable": true } }, "additionalProperties": false, "description": "Product badge or label to display on product" }, "OmniumProductCategory": { "type": "object", "properties": { "id": { "type": "string", "description": "Product category ID (Calculated, unique, including language prefix: {CategoryId}_{Language})", "nullable": true }, "categoryId": { "type": "string", "description": "Product category ID (Without language prefix). Required when adding a new category", "nullable": true }, "name": { "type": "string", "description": "Product category name", "nullable": true }, "description": { "type": "string", "description": "Product category short description", "nullable": true }, "parentId": { "type": "string", "description": "Parent category ID", "nullable": true }, "language": { "type": "string", "description": "Product category language code", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Properties", "nullable": true }, "isMainCategory": { "type": "boolean", "description": "Is product category a primary category" }, "imageUrl": { "type": "string", "description": "Image Url", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product category media files", "nullable": true }, "isHidden": { "type": "boolean", "description": "True if category should be hidden to end users" }, "metaDescription": { "type": "string", "description": "Meta description", "nullable": true }, "metaTitle": { "type": "string", "description": "Meta title", "nullable": true }, "metaKeywords": { "type": "string", "description": "Meta keywords", "nullable": true }, "sortIndex": { "type": "integer", "description": "Sort index", "format": "int32" }, "productSearchId": { "type": "string", "description": "Product search ID. If this property has value, the category is a dynamic category representing a saved search request. Use GetByProductSearch endpoint to fetch products.", "nullable": true }, "googleProductCategoryId": { "type": "string", "description": "Google's category id of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)).", "nullable": true } }, "additionalProperties": false, "description": "Product category" }, "OmniumProductCategoryOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumProductCategoryOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProductCategoryPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Product category ID (Calculated, unique, including language prefix: {CategoryId}_{Language}). Used to identify the category to patch.", "nullable": true }, "categoryId": { "type": "string", "description": "Product category ID (Without language prefix)", "nullable": true }, "name": { "type": "string", "description": "Product category name", "nullable": true }, "description": { "type": "string", "description": "Product category short description", "nullable": true }, "parentId": { "type": "string", "description": "Parent category ID", "nullable": true }, "language": { "type": "string", "description": "Product category language code", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Properties", "nullable": true }, "keepExistingProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "isMainCategory": { "type": "boolean", "description": "Is product category a primary category", "nullable": true }, "imageUrl": { "type": "string", "description": "Image Url", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product category media files", "nullable": true }, "keepExistingAssets": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'Assets' list. If true, new assets will be added to the existing list of assets. 'True' by default.", "nullable": true }, "isHidden": { "type": "boolean", "description": "True if category should be hidden to end users", "nullable": true }, "metaDescription": { "type": "string", "description": "Meta description", "nullable": true }, "metaTitle": { "type": "string", "description": "Meta title", "nullable": true }, "metaKeywords": { "type": "string", "description": "Meta keywords", "nullable": true }, "sortIndex": { "type": "integer", "description": "Sort index", "format": "int32", "nullable": true }, "productSearchId": { "type": "string", "description": "Product search ID. If this property has value, the category is a dynamic category representing a saved search request.", "nullable": true }, "googleProductCategoryId": { "type": "string", "description": "Google's category id of the item (see Google product taxonomy).", "nullable": true }, "fieldsToForceNull": { "type": "array", "items": { "type": "string" }, "description": "Force nullable category fields to null. Use the property path, e.g. \"Description\".", "nullable": true } }, "additionalProperties": false, "description": "Product category patch model for partial updates" }, "OmniumProductCategoryRelationsRequest": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID", "nullable": true }, "productCategoryId": { "type": "string", "description": "Product Category ID", "nullable": true } }, "additionalProperties": false, "description": "Request object for adding multiple categories to multiple products" }, "OmniumProductCategorySearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items pr page", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch", "format": "int32" }, "productCategoryId": { "type": "string", "description": "Search by category id", "nullable": true }, "parentIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by parent IDs", "nullable": true }, "language": { "type": "string", "description": "Language filter (language code)", "nullable": true }, "productCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by category IDs", "nullable": true }, "ratingType": { "type": "string", "description": "Filter by rating", "nullable": true }, "searchText": { "type": "string", "description": "Free text search", "nullable": true }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Filter by facets", "nullable": true } }, "additionalProperties": false, "description": "Search request object for products" }, "OmniumProductCategoryTreeViewModel": { "type": "object", "properties": { "productCategory": { "$ref": "#/components/schemas/OmniumProductCategory" }, "productCount": { "type": "integer", "description": "Number of products in category", "format": "int32" }, "subCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategoryTreeViewModel" }, "description": "List of product category sub items", "nullable": true } }, "additionalProperties": false, "description": "View model for product category tree" }, "OmniumProductCategoryUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "Total number of categories processed", "format": "int32" }, "updatedCount": { "type": "integer", "description": "Number of categories updated", "format": "int32" }, "unchangedCount": { "type": "integer", "description": "Number of categories unchanged", "format": "int32" }, "notFoundCount": { "type": "integer", "description": "Number of categories not found", "format": "int32" }, "notFoundIds": { "type": "array", "items": { "type": "string" }, "description": "List of category IDs that were not found", "nullable": true }, "errorCount": { "type": "integer", "description": "Number of errors encountered", "format": "int32" }, "errorMessage": { "type": "string", "description": "Error messages", "nullable": true }, "isModified": { "type": "boolean", "description": "True if any category was modified" } }, "additionalProperties": false, "description": "Result of a product category patch operation" }, "OmniumProductColli": { "type": "object", "properties": { "weight": { "type": "number", "description": "Gram", "format": "double", "nullable": true }, "height": { "type": "number", "description": "Cm", "format": "double", "nullable": true }, "length": { "type": "number", "description": "Cm", "format": "double", "nullable": true }, "width": { "type": "number", "description": "Cm", "format": "double", "nullable": true }, "volume": { "type": "number", "description": "Dm3", "format": "double", "nullable": true }, "isSentSeparately": { "type": "boolean", "description": "True if colli must be set as single colli", "nullable": true }, "isFreight": { "type": "boolean", "description": "True if colli must be sendt as freight", "nullable": true } }, "additionalProperties": false, "description": "Shipment colli" }, "OmniumProductComponent": { "type": "object", "properties": { "componentId": { "type": "string", "description": "Component ID (Unique GUID)", "nullable": true }, "id": { "type": "string", "description": "OBSOLETE Component product ID - Use ProductId instead", "nullable": true }, "productId": { "type": "string", "description": "Component product ID", "nullable": true }, "skuId": { "type": "string", "description": "Component SkuId - use this to preselect variant in package.", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of component in package", "format": "decimal" }, "isRequired": { "type": "boolean", "description": "This property is for external use only and has no functional effect within Omnium." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComponentOption" }, "description": "A list of selectable options for this component. The SkuId is populated when an option is selected.", "nullable": true }, "componentName": { "type": "string", "description": "The display name of the component. Primarily relevant when using component options where no default value is selected.", "nullable": true } }, "additionalProperties": false, "description": "Product package component" }, "OmniumProductContentLanguage": { "type": "object", "properties": { "languageCode": { "type": "string", "nullable": true }, "translateKey": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumProductFacet": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumProductFieldSelection": { "type": "object", "properties": { "excludeVariants": { "type": "boolean", "description": "Exclude all variant data", "nullable": true }, "excludeCategories": { "type": "boolean", "description": "Exclude all product category data", "nullable": true }, "excludePrices": { "type": "boolean", "description": "Exclude all price data", "nullable": true }, "excludeProperties": { "type": "boolean", "description": "Exclude all custom properties", "nullable": true }, "excludeAssets": { "type": "boolean", "description": "Exclude all assets (except MainImageUrl)", "nullable": true }, "excludeInventory": { "type": "boolean", "description": "Exclude all inventory data", "nullable": true }, "include": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Only return these specific fields. Fields use camelCase with dot notation for nested fields.\r\nWhen set, only these fields (plus Id) are returned.", "nullable": true }, "exclude": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude these specific fields. Fields use camelCase with dot notation.", "nullable": true } }, "additionalProperties": false, "description": "Product-specific field selection with shorthand flags for common product field exclusions.\r\nExtends the generic OmniumFieldSelection with product-specific convenience flags." }, "OmniumProductGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "Product group ID", "nullable": true }, "name": { "type": "string", "description": "Product group name", "nullable": true } }, "additionalProperties": false, "description": "Product group" }, "OmniumProductGroupings": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the product group or category.", "nullable": true }, "amount": { "type": "number", "description": "Total amount for this product group.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of items sold in this group.", "format": "int32" }, "vatValue": { "type": "number", "description": "VAT rate percentage applied to this product group (optional).", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Represents sales grouped by product category or group." }, "OmniumProductGroupRefund": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the product group or category.", "nullable": true }, "amount": { "type": "number", "description": "Total refund amount for this product group.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of items refunded in this group.", "format": "int32" }, "vatValue": { "type": "number", "description": "VAT rate percentage applied to this product group.", "format": "decimal" } }, "additionalProperties": false, "description": "Represents refunds/returns grouped by product category." }, "OmniumProductInventory": { "type": "object", "properties": { "warehouseCode": { "type": "string", "description": "Warehode code", "nullable": true }, "quantity": { "type": "number", "description": "Available quantity", "format": "decimal", "nullable": true } }, "additionalProperties": false }, "OmniumProductListItemViewModel": { "type": "object", "properties": { "id": { "maxLength": 10000, "minLength": 0, "type": "string", "description": "Product unique ID", "nullable": true }, "productId": { "type": "string", "description": "Product ID", "nullable": true }, "skuId": { "type": "string", "description": "Product SKU ID", "nullable": true }, "ean": { "type": "string", "description": "EAN code", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN codes", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name", "nullable": true }, "mainImageUrl": { "type": "string", "description": "Product image url", "nullable": true }, "isActive": { "type": "boolean", "description": "True if product is active. False if it should be hidden from customers." }, "isSku": { "type": "boolean", "description": "True if product is stock keeping unit / product or variant that can be sold" }, "isBundle": { "type": "boolean", "description": "True if product is a bundle of other products (unlike package, price is sum of components)" }, "isPackage": { "type": "boolean", "description": "True if product is package of other products (unlike bundle, price is specified for package)" }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock" }, "isRental": { "type": "boolean", "description": "If true, the product is available for rental" }, "rentalSourceProductId": { "type": "string", "description": "The SKU ID of the original product this rental product was created from", "nullable": true }, "colli": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductColli" }, "description": "List of colli, used for shipment", "nullable": true }, "catalog": { "type": "string", "description": "Catalog name", "nullable": true, "deprecated": true }, "catalogNodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Catalog nodes (if multiple)", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Market IDs", "nullable": true }, "variants": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" }, "description": "List of variants", "nullable": true }, "prices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of prices", "nullable": true }, "price": { "$ref": "#/components/schemas/OmniumPrice" }, "expectedDeliveryDate": { "type": "string", "description": "Total inventory quantity for all warehouses", "format": "date-time", "nullable": true }, "inventory": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductInventory" }, "description": "List of warehouse inventory for the product.", "nullable": true }, "cost": { "type": "number", "description": "Product net cost", "format": "decimal" }, "costInDefaultCurrency": { "type": "number", "description": "Product cost in default currency", "format": "decimal", "nullable": true }, "costPrices": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCostPrice" }, "description": "List of product cost prices retrieved from separate index. Only relevant if HasSeparateCostPrices = true.", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier", "nullable": true }, "supplierName": { "type": "string", "description": "Name of main product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Main supplier ID", "nullable": true }, "averageRating": { "type": "number", "description": "Average rating for product", "format": "double" }, "ratingCount": { "type": "integer", "description": "Number of ratings for the product", "format": "int32" }, "brand": { "type": "string", "description": "Product brand", "nullable": true }, "color": { "type": "string", "description": "Product color", "nullable": true }, "gender": { "type": "string", "description": "Product gender", "nullable": true }, "season": { "type": "string", "description": "Product season", "nullable": true }, "countryOfOrigin": { "type": "string", "description": "Product country of origin", "nullable": true }, "sizeType": { "type": "string", "description": "Product size type", "nullable": true }, "weight": { "type": "number", "description": "Product weight in kilograms (kg)", "format": "double", "nullable": true }, "unit": { "type": "string", "description": "Product unit, used for describing what unit the quantities are in", "nullable": true }, "units": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductUnit" }, "description": "List of additional units", "nullable": true }, "size": { "type": "string", "description": "Product size", "nullable": true }, "parentId": { "type": "string", "description": "Product parent ID", "nullable": true }, "seoInfo": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "productCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories", "nullable": true, "deprecated": true }, "categories": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories", "nullable": true }, "categoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of category IDs", "nullable": true }, "mainCategoryId": { "type": "string", "description": "Main category id", "nullable": true }, "mainCategoryName": { "type": "string", "description": "Main category name", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of product tags", "nullable": true }, "badges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductBadge" }, "description": "List of product badges or labels to display on product", "nullable": true }, "relatedProducts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProduct" }, "description": "Related products", "nullable": true }, "shortDescription": { "type": "string", "description": "Short product description", "nullable": true }, "productType": { "type": "string", "description": "Product type which product will inherit properties from", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true }, "specification": { "type": "string", "description": "Product specification", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "If true, this variant should represent the product in flattened variant lists" }, "published": { "type": "string", "description": "Published datetime.", "format": "date-time", "nullable": true }, "stopPublished": { "type": "string", "description": "Product activation end date. Can be null", "format": "date-time", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOption" }, "description": "Available product options for the product", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Components included in product - only relevant if products is package/bundle", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotions associated with the product", "nullable": true }, "isVirtual": { "type": "boolean", "description": "If true the product inventory status is ignored. Inventory for these products will not be taken into account nor affected by workflow or order management.", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available store IDs. If not set, the product will be available for all stores.", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "nullable": true }, "leadTime": { "type": "integer", "description": "Lead time in days", "format": "int32", "nullable": true }, "supplierLeadTime": { "type": "integer", "description": "Supplier lead time in days", "format": "int32", "nullable": true }, "sortIndex": { "type": "integer", "description": "Calculated - Used for manual sorting of products (SortIndexBase + SortIndexBoost)", "format": "int32", "nullable": true }, "sortIndexBase": { "type": "integer", "description": "Used for manual sorting of products", "format": "int32", "nullable": true }, "sortIndexBoost": { "type": "integer", "description": "Used for manual sorting of products", "format": "int32", "nullable": true }, "modified": { "type": "string", "description": "Used for manual sorting of products", "format": "date-time", "nullable": true }, "lowestPriceHistory": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceReference" }, "description": "Price history (lowest prices for each market)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external IDs. External IDs are visible in Omnium's UI and useful for display, searching and filtering on IDs originating from other systems.", "nullable": true }, "discontinued": { "type": "string", "description": "Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "View model for product list item" }, "OmniumProductListItemViewModelOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProductListItemViewModelRecommendation": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/OmniumProductListItemViewModel" }, "recommendedId": { "type": "string", "nullable": true }, "score": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OmniumProductOmniumQueryResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of items matching the query (not just this page)", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "The items in this page/batch", "nullable": true }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet/aggregation results. Only populated when facets are specified in the request.", "nullable": true } }, "additionalProperties": false, "description": "Generic result from a paginated Query endpoint. Contains plain entity objects.\r\nWorks with any entity type: OmniumProduct, OmniumOrder, OmniumCustomer, OmniumCart, etc.\r\nFor scroll-capable endpoints, see Omnium.Public.Search.Query.OmniumScrollableQueryResult`1." }, "OmniumProductOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumProductOmniumScrollableQueryResult": { "type": "object", "properties": { "scrollId": { "type": "string", "description": "Scroll continuation token. Pass this to the scroll continuation endpoint to fetch the next batch.\r\nNull when there are no more results.", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of items matching the query (not just this page)", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "The items in this page/batch", "nullable": true }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet/aggregation results. Only populated when facets are specified in the request.", "nullable": true } }, "additionalProperties": false, "description": "Result from a scroll-capable Query endpoint. Adds a scroll continuation token\r\nto the standard Omnium.Public.Search.Query.OmniumQueryResult`1." }, "OmniumProductOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProductOption": { "type": "object", "properties": { "optionTitle": { "type": "string", "description": "Title of the option", "nullable": true }, "type": { "type": "string", "description": "Type of option", "nullable": true }, "values": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOptionValue" }, "description": "Available values for the product option", "nullable": true }, "isRequired": { "type": "boolean", "description": "Mark the product option as required", "nullable": true }, "sku": { "type": "string", "description": "Sku reference for the product options", "nullable": true }, "prices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "Product option specific prices (the prices will fall back to prices set on the original product if not set here)", "nullable": true } }, "additionalProperties": false, "description": "Additional options for a product" }, "OmniumProductOptionsViewModel": { "type": "object", "properties": { "productOptionViewModels": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOptionViewModel" }, "description": "List of product options", "nullable": true }, "products": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "Referenced product(s) from the product options", "nullable": true } }, "additionalProperties": false, "description": "Product options view model, containing both product options and the reference product models" }, "OmniumProductOptionValue": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the product option value", "nullable": true }, "value": { "type": "string", "description": "Value", "nullable": true }, "sku": { "type": "string", "description": "Sku reference", "nullable": true }, "maxSize": { "type": "number", "description": "Max input size for the text input type of option", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "The product option value is a pointer to a product in Omnium with the IsProductOption property set to 'true'" }, "OmniumProductOptionValueViewModel": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the product option value", "nullable": true }, "value": { "type": "string", "description": "Value", "nullable": true }, "price": { "$ref": "#/components/schemas/OmniumPrice" }, "sku": { "type": "string", "description": "Sku reference", "nullable": true }, "maxSize": { "type": "number", "description": "Max input size for the text input type of option", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": " The product option value is a pointer to a product in Omnium with the IsProductOption property set to 'true'.\r\nThe view model also contains a price, which is populated by the reference sku." }, "OmniumProductOptionViewModel": { "type": "object", "properties": { "optionTitle": { "type": "string", "description": "Title of the option", "nullable": true }, "sku": { "type": "string", "description": "Sku reference", "nullable": true }, "type": { "type": "string", "description": "Type of option", "nullable": true }, "values": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOptionValueViewModel" }, "description": "Available values for the product option, populated with prices", "nullable": true }, "price": { "$ref": "#/components/schemas/OmniumPrice" }, "isRequired": { "type": "boolean", "description": "If the product option should be mandatory for the product selected", "nullable": true } }, "additionalProperties": false, "description": "Single product options view model" }, "OmniumProductPatch": { "type": "object", "properties": { "parentId": { "type": "string", "description": "Product parent ID", "nullable": true }, "variants": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumVariantPatch" }, "description": "List of variant patches.", "nullable": true }, "removeExistingVariants": { "type": "boolean", "description": "If true, existing variants will be deleted and only variants in the variant patch will be added. 'False' by default.", "nullable": true }, "siblings": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of sibling product IDs", "nullable": true }, "categories": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories", "nullable": true }, "categoryIdsToRemove": { "type": "array", "items": { "type": "string" }, "description": "List of CategoryIds to remove from the product. This removes the categories from both CategoryIds and ProductCategories", "nullable": true }, "mainCategoryId": { "type": "string", "description": "Main category id", "nullable": true }, "mainCategoryName": { "type": "string", "description": "Main category name", "nullable": true }, "leadTime": { "type": "integer", "description": "Lead time in days", "format": "int32", "nullable": true }, "supplierLeadTime": { "type": "integer", "description": "Supplier lead time in days", "format": "int32", "nullable": true }, "isLocalProduct": { "type": "boolean", "description": "Only relevant when IsLocalProductsEnabled is enabled in productSettings. When enabled, both 'IsLocalProduct' must be activated and the user must have access to a selected store in order to edit the product", "nullable": true }, "id": { "type": "string", "description": "Product unique ID", "nullable": true }, "productId": { "type": "string", "description": "Product ID", "nullable": true }, "skuId": { "type": "string", "description": "Product unique ID", "nullable": true }, "ean": { "type": "string", "description": "EAN code", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN codes", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "published": { "type": "string", "description": "Date product is published", "format": "date-time", "nullable": true }, "stopPublished": { "type": "string", "description": "Product activation end date. Can be null", "format": "date-time", "nullable": true }, "discontinued": { "type": "string", "description": "Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "True if product is active. False if it should be hidden from customers.", "nullable": true }, "catalog": { "type": "string", "description": "Catalog name", "nullable": true }, "mainImageUrl": { "type": "string", "description": "Product image url", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product media files", "nullable": true }, "keepExistingAssets": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'Assets' list. If true, new assets will be added to the existing list of assets. 'True' by default.", "nullable": true }, "seoInfo": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "entryType": { "type": "string", "description": "Product entry type", "nullable": true }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date", "format": "date-time", "nullable": true }, "isSku": { "type": "boolean", "description": "True if product is stock keeping unit / product or variant that can be sold", "nullable": true }, "isBundle": { "type": "boolean", "description": "True if product is a bundle of other products (unlike package, price is sum of components)", "nullable": true }, "isPackage": { "type": "boolean", "description": "True if product is package of other products (unlike bundle, price is specified for package)", "nullable": true }, "isKit": { "type": "boolean", "description": "True if product is a kit (product composed of other products, assembled at fulfillment)", "nullable": true }, "isWriteProtected": { "type": "boolean", "description": "True if product is write protected by user. PIM integrations should not override product information.", "nullable": true }, "isInStock": { "type": "boolean", "description": "True if product is in stock", "nullable": true }, "catalogNodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Catalog nodes (if multiple)", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity (point of reordering)", "format": "decimal", "nullable": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity (what should be in stock after new supply)", "format": "decimal", "nullable": true }, "weight": { "type": "number", "description": "Product weight", "format": "double", "nullable": true }, "taxCategory": { "type": "string", "description": "Product tax category", "nullable": true }, "taxGroupCode": { "type": "string", "description": "References a TaxGroup.Code in the tenant's chart of tax groups.\r\nWhen null, the tenant's DefaultTaxGroupCode applies (if feature is enabled).\r\nHas no effect when AccountingSettings.TaxGroupsEnabled = false.", "nullable": true }, "taxRate": { "type": "number", "description": "Per-product VAT rate used as a fallback when tax groups are not configured.\r\nApplied to any price that has no TaxRate of its own at save time.\r\nTax-group resolution takes precedence when enabled.", "format": "decimal", "nullable": true }, "associatedProducts": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Associated product IDs", "nullable": true }, "prices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of all product prices - all currencies, campaigns, customer prices etc", "nullable": true }, "pricesMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "dontOverwriteExistingPropertyValues": { "type": "boolean", "description": "Set to 'true' if you want to skip updating properties that already exists and has a value. If you want to add values to a list/multiselect property, make sure this option is set to 'true' along with valueType: 'List' or 'DropDown'. Otherwise the list property will be overwritten.", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of available market IDs", "nullable": true }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOption" }, "description": "Available product options for the product", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available store IDs", "nullable": true }, "marketGroupIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of available market group IDs", "nullable": true }, "language": { "type": "string", "description": "Product language", "nullable": true }, "location": { "type": "string", "description": "The location of the product in the warehouse.", "nullable": true }, "color": { "type": "string", "description": "Product color", "nullable": true }, "brand": { "type": "string", "description": "Product brand", "nullable": true }, "size": { "type": "string", "description": "Product size", "nullable": true }, "shortDescription": { "type": "string", "description": "Short product description", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true }, "specification": { "type": "string", "description": "Product Specification", "nullable": true }, "supplierName": { "type": "string", "description": "Name of main product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Main supplier ID", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier, used when creating purchase orders", "nullable": true }, "supplierColor": { "type": "string", "description": "Color from supplier", "nullable": true }, "supplierPackagingUnit": { "type": "string", "description": "Supplier packaging quantity", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "additionalSuppliers": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductSupplier" }, "description": "List of additional product suppliers", "nullable": true }, "sizeType": { "type": "string", "description": "Product size type", "nullable": true }, "unit": { "type": "string", "description": "Product unit, used for describing what unit the quantities are in", "nullable": true }, "units": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductUnit" }, "description": "List of additional units", "nullable": true }, "colli": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductColli" }, "description": "List of colli, used for shipment", "nullable": true }, "relatedProducts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProduct" }, "description": "Related products", "nullable": true }, "season": { "type": "string", "description": "Product season", "nullable": true }, "badges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductBadge" }, "description": "List of product badges or labels to display on product", "nullable": true }, "sortIndexBoost": { "type": "integer", "description": "Sort index set by API / GUI", "format": "int32", "nullable": true }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock", "nullable": true }, "isPriceLocked": { "type": "boolean", "description": "When true, the price on order lines created from this product will be locked and not recalculated.", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "If true, this variant should represent the product in flattened variant lists", "nullable": true }, "isSerializableProduct": { "type": "boolean", "description": "If true, the product is serializable, and order line should contain serial number when completed", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name", "nullable": true }, "cost": { "type": "number", "description": "Product net cost", "format": "decimal", "nullable": true }, "costCurrency": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components (used when product is a package)", "nullable": true }, "productType": { "type": "string", "description": "Type of product", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of tag IDs", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external product IDs. Could be ids in eCommerce platform etc", "nullable": true }, "isNotRatable": { "type": "boolean", "description": "Set to true if this product should be excluded from rating emails/forms", "nullable": true }, "excludeFromPromotions": { "type": "boolean", "description": "Set to true if this product should be excluded from promotions", "nullable": true }, "salesStartDate": { "type": "string", "description": "Embargo date: product cannot be sold before this date", "format": "date-time", "nullable": true }, "fixedPriceCode": { "type": "string", "description": "Price protection category (e.g. book law)", "nullable": true }, "fixedPriceEndDate": { "type": "string", "description": "Discounts are blocked until this date", "format": "date-time", "nullable": true }, "discountBlocked": { "type": "boolean", "description": "Permanent discount prohibition", "nullable": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "countryOfOrigin": { "type": "string", "description": "Country of origin", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Virtual products will not affect inventory.", "nullable": true }, "assortmentCodes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAssortmentCode" }, "description": "Assortment codes for the product", "nullable": true }, "fieldsToForceNull": { "type": "array", "items": { "type": "string" }, "description": "Force nullable product fields to null. Use the property path, e.g. \"SeoInfo.Description\".", "nullable": true }, "freightClass": { "type": "string", "description": "Freight class", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the product", "nullable": true } }, "additionalProperties": false, "description": "Product patch" }, "OmniumProductPriceContext": { "type": "object", "properties": { "marketIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Markets to price for. Overrides the top-level {MarketIds} for price selection only\r\n(products are still filtered by the top-level markets).", "nullable": true }, "marketGroupIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Market groups to price for (expanded to their member markets). Overrides the top-level\r\n{MarketGroupIds} for price selection only.", "nullable": true }, "storeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Stores to price for. Overrides the top-level {StoreIds} for price selection only — use this\r\nto get store-specific pricing without restricting which products are returned.", "nullable": true }, "storeGroupIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Store groups to price for. Store-group prices scoped to any of these groups are returned in\r\naddition to non-store-group prices. Has no top-level equivalent — store groups are price-only.", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID for customer-specific pricing. Overrides the top-level {CustomerId} for price\r\nselection only — it does not change customer assortment/availability.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer groups for group-specific pricing. Overrides the top-level {CustomerGroups} for\r\nprice selection only.", "nullable": true }, "additionalStoreIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Additional store IDs whose prices are appended to the result (after the primary store prices,\r\npreserving sort order). Has no top-level equivalent.", "nullable": true }, "isCustomerClubMember": { "type": "boolean", "description": "Controls customer club (member) pricing. Overrides the top-level {IsCustomerClubMember}.\r\n- true: club prices are included and the single 'price' field can be a club price.\r\n- false: club prices are excluded.\r\n- null (default): falls back to the top-level value.", "nullable": true }, "includeAllPrices": { "type": "boolean", "description": "When true, all prices are returned regardless of context (products are still filtered by the\r\ntop-level availability fields). Overrides the top-level {IncludeAllPrices}.", "nullable": true } }, "additionalProperties": false, "description": "Optional price scope for the product Query endpoints. Controls which prices are returned and how\r\nthey are sorted — it never affects which products are returned (use the top-level\r\n{MarketIds}/{StoreIds}/{ProductCategoryIds} etc. for availability).\r\n \r\nEvery field is optional and overrides the matching top-level field for pricing only; anything\r\nleft null falls back to the top-level value. So the common case needs no price context at all —\r\nsetting top-level {MarketIds} already scopes both availability and prices to that market.\r\nReach for this object only when pricing should differ from availability, e.g. \"products available in\r\nmarket A, priced for store group G\" or \"products in SWE, priced as NOR\".\r\n \r\nA price is kept when, for every dimension, it either matches the requested value or is\r\nunscoped on that dimension (no store group, no store, …). Dimensions are combined with AND, so you\r\nget market-relevant and store-group-relevant prices, but never a store-group price belonging\r\nto a different market." }, "OmniumProductPromotionIdSearchResult": { "type": "object", "properties": { "promotionId": { "type": "string", "description": "Promotion ID", "nullable": true }, "promotionName": { "type": "string", "description": "Promotion name", "nullable": true }, "productCount": { "type": "integer", "description": "Number of products", "format": "int32" } }, "additionalProperties": false, "description": "Active promotions search result" }, "OmniumProductPromotionIdSearchResultOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductPromotionIdSearchResult" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProductQueryRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items per page. Default applied when null: 10. Allowed range: 1–1000.", "format": "int32", "nullable": true }, "page": { "type": "integer", "description": "Page number (1-indexed). Default applied when null: 1. Max offset (Take * Page) is 10,000.\r\nFor larger datasets — bulk exports, system syncs, reindexing — use the scroll endpoint instead.", "format": "int32", "nullable": true }, "marketIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Filter products by market IDs (product availability). Also the default market for pricing unless\r\noverridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. The first market is the primary context for price\r\nsorting and language resolution.", "nullable": true }, "marketGroupIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Filter products by market group IDs (product availability); all member markets are included.\r\nAlso the default market scope for pricing unless overridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "storeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter products by store IDs (assortment availability). Also the default store scope for pricing\r\nunless overridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. The first store is the primary context for\r\nprice sorting and assortment.", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID for customer assortment filtering (availability) and customer-specific pricing.\r\nThe price customer can be overridden independently via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer groups for assortment (availability) and group-specific pricing. The price groups can be\r\noverridden independently via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "priceContext": { "$ref": "#/components/schemas/OmniumProductPriceContext" }, "priceValidFrom": { "type": "string", "description": "Only return prices valid from this date", "format": "date-time", "nullable": true }, "priceValidTo": { "type": "string", "description": "Only return prices valid until this date", "format": "date-time", "nullable": true }, "includeAllPrices": { "type": "boolean", "description": "When true, all prices are returned regardless of price context. Products are still filtered by\r\nthe top-level availability fields. Use this for data export or price management scenarios.\r\nDefault: false. Overridable via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext." }, "isCustomerClubMember": { "type": "boolean", "description": "Controls customer club (member) pricing. Club prices are excluded by default.\r\n- true: treated as a club member — club prices are included and the single 'price' field can be a\r\n club price (the lowest applicable price wins).\r\n- null (default) or false: club prices are excluded and the single 'price' field is the lowest\r\n non-club price.\r\nOverridable via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. Ignored when Omnium.Public.Products.Query.OmniumProductQueryRequestBase.IncludeAllPrices is true.", "nullable": true }, "searchText": { "maxLength": 300, "type": "string", "description": "Free text search query. Max 300 characters.", "nullable": true }, "productIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by Product.ProductId (your business product ID). Strict match — does not search SKU or other ID fields.\r\nUse Omnium.Public.Products.Query.OmniumProductQueryRequestBase.SkuIds for SKU lookups, Omnium.Public.Products.Query.OmniumProductQueryRequestBase.Ids for internal IDs, or Omnium.Public.Products.Query.OmniumProductQueryRequestBase.AnyIds\r\nwhen the ID type is unknown.", "nullable": true }, "skuIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by SKU. Matches Product.SkuId OR Variants[].SkuId — a SKU is treated as a single logical\r\nconcept regardless of whether it lives at the product or variant level.", "nullable": true }, "ids": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by Product.Id (the internal Omnium document identifier). Strict match.\r\nMost consumers should use Omnium.Public.Products.Query.OmniumProductQueryRequestBase.ProductIds instead.", "nullable": true }, "anyIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by ANY ID type. Matches against Product.ProductId, Product.SkuId, Product.Id, Product.ParentId,\r\nor Variants[].SkuId. Use this when you don't know which type of ID you have (e.g. barcode scanning,\r\ndirty data imports, customer-provided IDs). Prefer the strict fields (Omnium.Public.Products.Query.OmniumProductQueryRequestBase.ProductIds,\r\nOmnium.Public.Products.Query.OmniumProductQueryRequestBase.SkuIds, Omnium.Public.Products.Query.OmniumProductQueryRequestBase.Ids) when the ID type is known — they are more predictable.", "nullable": true }, "productParentIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by parent product IDs", "nullable": true }, "productCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by product category IDs", "nullable": true }, "excludedProductCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from results", "nullable": true }, "excludedProductIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Product IDs to exclude from results", "nullable": true }, "gtins": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by GTIN codes (searches EAN, GTINS, and Units.EAN on products and variants)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by product tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags to exclude from results", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by external IDs", "nullable": true }, "supplierIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by supplier IDs", "nullable": true }, "supplierSkuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by supplier SKU IDs", "nullable": true }, "seoUris": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by SEO URIs", "nullable": true }, "componentIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by component IDs (returns products containing any of the specified component IDs)", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by promotion IDs (returns products with active prices matching any of the specified promotion IDs)", "nullable": true }, "assortmentCodeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Filter by assortment code IDs", "nullable": true }, "ignoreCustomerAssortment": { "type": "boolean", "description": "If true, the customer's assortment codes from the price context will not be applied as a filter" }, "isAssortmentCodesRequired": { "type": "boolean", "description": "When true, the product must have a matching assortment code. When null, uses the tenant configuration default.", "nullable": true }, "productType": { "type": "string", "description": "Filter by product type", "nullable": true }, "isActive": { "type": "boolean", "description": "True: only active products. False: only inactive products. Null: both.", "nullable": true }, "isSku": { "type": "boolean", "description": "True: only SKU products (without variants). False: only non-SKU products. Null: both.", "nullable": true }, "isBundle": { "type": "boolean", "description": "True: only bundle products. False: only non-bundles. Null: both.", "nullable": true }, "isPackage": { "type": "boolean", "description": "True: only package products. False: only non-packages. Null: both.", "nullable": true }, "isDeleted": { "type": "boolean", "description": "True: only deleted products. False: only non-deleted products. Null (default): both.", "nullable": true }, "isInStock": { "type": "boolean", "description": "True: only products in stock. False: only products not in stock. Null: both.\r\nShould be combined with InStockWarehouseIds or InStockMarketIds for specific filtering.", "nullable": true }, "isOnSale": { "type": "boolean", "description": "True: only products on sale. False: only products not on sale. Null: both.", "nullable": true }, "isPublished": { "type": "boolean", "description": "True: only products published today. Null: no publication filter.", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "True: only main product variants. Null: both.", "nullable": true }, "isAvailableOnline": { "type": "boolean", "description": "True: only products available online. False: only products not available online. Null: both.", "nullable": true }, "isLocalProduct": { "type": "boolean", "description": "True: only local products. False: only non-local products. Null: both.\r\nOnly relevant when IsLocalProductsEnabled is enabled in product settings.", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Filter products modified on or after this date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Filter products modified on or before this date", "format": "date-time", "nullable": true }, "startPublishFrom": { "type": "string", "description": "Filter products published on or after this date", "format": "date-time", "nullable": true }, "startPublishTo": { "type": "string", "description": "Filter products published on or before this date", "format": "date-time", "nullable": true }, "stopPublishFrom": { "type": "string", "description": "Filter products with publication end date on or after this date", "format": "date-time", "nullable": true }, "stopPublishTo": { "type": "string", "description": "Filter products with publication end date on or before this date", "format": "date-time", "nullable": true }, "priceFrom": { "type": "number", "description": "Filter products with price greater than or equal to this value.\r\nUses the first market from MarketIds for price resolution.", "format": "decimal", "nullable": true }, "priceTo": { "type": "number", "description": "Filter products with price less than or equal to this value.\r\nUses the first market from MarketIds for price resolution.", "format": "decimal", "nullable": true }, "priceActivatedFrom": { "type": "string", "description": "Filter products with prices activated on or after this date", "format": "date-time", "nullable": true }, "priceActivatedTo": { "type": "string", "description": "Filter products with prices activated on or before this date", "format": "date-time", "nullable": true }, "priceDeactivatedFrom": { "type": "string", "description": "Filter products with prices deactivated on or after this date", "format": "date-time", "nullable": true }, "priceDeactivatedTo": { "type": "string", "description": "Filter products with prices deactivated on or before this date", "format": "date-time", "nullable": true }, "isUnionDeltaQuery": { "type": "boolean", "description": "When true, uses OR logic for delta queries: returns products modified OR with price changes.\r\nWhen false (default), uses AND logic.", "nullable": true }, "productLanguage": { "type": "string", "description": "Language code (e.g. \"en\", \"no\", \"es\") for filtering product content", "nullable": true }, "ignoreLanguageFilter": { "type": "boolean", "description": "When true, ignores language filtering and searches across all languages.\r\nWhen false/null, uses the specified ProductLanguage. If no language is specified\r\nand markets are provided, resolves language from the market.", "nullable": true }, "inStockWarehouseIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Warehouse IDs for the IsInStock filter. If not set, IsInStock matches any warehouse.", "nullable": true }, "inStockMarketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Market IDs for the IsInStock filter. If not set, IsInStock matches any market.", "nullable": true }, "includeInventoryForSelectedStores": { "type": "boolean", "description": "When true, inventory data for selected stores is included in the response", "nullable": true }, "properties": { "maxLength": 20, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Filter products by custom property key/value pairs (AND semantics — products must match\r\nALL listed property pairs to be included). Each entry is a (key, value) pair on the product's\r\nProperties collection. Useful for narrowing by attributes like Color, Size, Brand, etc.", "nullable": true }, "excludedProperties": { "maxLength": 20, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Exclude products matching any of these property key/value pairs. OR semantics — a product\r\nmatching any one excluded property is removed from the result.", "nullable": true }, "propertyListId": { "type": "string", "description": "Property list ID controlling which properties are RETURNED in the response (response shaping,\r\nnot filtering). Uses predefined named property lists from tenant settings — only properties\r\nwhose keys are in the named list will be present on the returned products.", "nullable": true }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet definitions to include in the response. When null or empty, no facets are returned.", "nullable": true }, "fields": { "$ref": "#/components/schemas/OmniumProductFieldSelection" }, "completionRate": { "$ref": "#/components/schemas/OmniumCompletionRateFilter" }, "sort": { "maxLength": 10, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSortField" }, "description": "Sort fields in priority order. Each entry specifies a field name and direction (\"asc\" or \"desc\").\r\nAvailable field names are entity-specific (e.g. \"price\", \"name\", \"modified\" for products).", "nullable": true } }, "additionalProperties": false, "description": "Request model for the paginated product Query endpoint (POST /api/products/Query).\r\nInherits all product filter fields from Omnium.Public.Products.Query.OmniumProductQueryRequestBase; adds\r\npagination controls.\r\n \r\nFor bulk extraction (full-catalog syncs, exports, reindexing), use\r\nOmnium.Public.Products.Query.OmniumProductScrollQueryRequest with the scroll endpoint instead." }, "OmniumProductSales": { "type": "object", "properties": { "costSum": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValueAggregateOmniumBucket" }, "description": "Total product cost", "nullable": true }, "extendedPriceSum": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValueAggregateOmniumBucket" }, "description": "Total sales price", "nullable": true }, "quantityStats": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStatsAggregateOmniumBucket" }, "description": "Total quantity stats", "nullable": true }, "returnedStats": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStatsAggregateOmniumBucket" }, "description": "Total number of return items stats", "nullable": true }, "cancelledStats": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStatsAggregateOmniumBucket" }, "description": "Total number of cancelled items stats", "nullable": true }, "storeTerms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTermsAggregationDataListOmniumBucket" }, "description": "Store/shop stat", "nullable": true }, "salesChannelTerms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTermsAggregationDataListOmniumBucket" }, "description": "Sales channel stats", "nullable": true }, "statusTerms": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTermsAggregationDataListOmniumBucket" }, "description": "Status stats", "nullable": true }, "profitChartSeries": { "$ref": "#/components/schemas/OmniumChart" }, "quantityChartSeries": { "$ref": "#/components/schemas/OmniumChart" } }, "additionalProperties": false, "description": "Class used for product sales Statistics" }, "OmniumProductsAndVariantsUpdateResult": { "type": "object", "properties": { "productUpdateResultTotal": { "$ref": "#/components/schemas/OmniumProductUpdateResult" }, "variantUpdateResultTotal": { "$ref": "#/components/schemas/OmniumProductUpdateResult" } }, "additionalProperties": false, "description": "Result for path update of product and variants" }, "OmniumProductScrollQueryRequest": { "type": "object", "properties": { "scrollSize": { "type": "integer", "description": "Number of items per scroll batch. Default applied when null: 500. Allowed range: 100–1000.", "format": "int32", "nullable": true }, "marketIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Filter products by market IDs (product availability). Also the default market for pricing unless\r\noverridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. The first market is the primary context for price\r\nsorting and language resolution.", "nullable": true }, "marketGroupIds": { "maxLength": 50, "type": "array", "items": { "type": "string" }, "description": "Filter products by market group IDs (product availability); all member markets are included.\r\nAlso the default market scope for pricing unless overridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "storeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter products by store IDs (assortment availability). Also the default store scope for pricing\r\nunless overridden by Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. The first store is the primary context for\r\nprice sorting and assortment.", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID for customer assortment filtering (availability) and customer-specific pricing.\r\nThe price customer can be overridden independently via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Customer groups for assortment (availability) and group-specific pricing. The price groups can be\r\noverridden independently via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext.", "nullable": true }, "priceContext": { "$ref": "#/components/schemas/OmniumProductPriceContext" }, "priceValidFrom": { "type": "string", "description": "Only return prices valid from this date", "format": "date-time", "nullable": true }, "priceValidTo": { "type": "string", "description": "Only return prices valid until this date", "format": "date-time", "nullable": true }, "includeAllPrices": { "type": "boolean", "description": "When true, all prices are returned regardless of price context. Products are still filtered by\r\nthe top-level availability fields. Use this for data export or price management scenarios.\r\nDefault: false. Overridable via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext." }, "isCustomerClubMember": { "type": "boolean", "description": "Controls customer club (member) pricing. Club prices are excluded by default.\r\n- true: treated as a club member — club prices are included and the single 'price' field can be a\r\n club price (the lowest applicable price wins).\r\n- null (default) or false: club prices are excluded and the single 'price' field is the lowest\r\n non-club price.\r\nOverridable via Omnium.Public.Products.Query.OmniumProductQueryRequestBase.PriceContext. Ignored when Omnium.Public.Products.Query.OmniumProductQueryRequestBase.IncludeAllPrices is true.", "nullable": true }, "searchText": { "maxLength": 300, "type": "string", "description": "Free text search query. Max 300 characters.", "nullable": true }, "productIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by Product.ProductId (your business product ID). Strict match — does not search SKU or other ID fields.\r\nUse Omnium.Public.Products.Query.OmniumProductQueryRequestBase.SkuIds for SKU lookups, Omnium.Public.Products.Query.OmniumProductQueryRequestBase.Ids for internal IDs, or Omnium.Public.Products.Query.OmniumProductQueryRequestBase.AnyIds\r\nwhen the ID type is unknown.", "nullable": true }, "skuIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by SKU. Matches Product.SkuId OR Variants[].SkuId — a SKU is treated as a single logical\r\nconcept regardless of whether it lives at the product or variant level.", "nullable": true }, "ids": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by Product.Id (the internal Omnium document identifier). Strict match.\r\nMost consumers should use Omnium.Public.Products.Query.OmniumProductQueryRequestBase.ProductIds instead.", "nullable": true }, "anyIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by ANY ID type. Matches against Product.ProductId, Product.SkuId, Product.Id, Product.ParentId,\r\nor Variants[].SkuId. Use this when you don't know which type of ID you have (e.g. barcode scanning,\r\ndirty data imports, customer-provided IDs). Prefer the strict fields (Omnium.Public.Products.Query.OmniumProductQueryRequestBase.ProductIds,\r\nOmnium.Public.Products.Query.OmniumProductQueryRequestBase.SkuIds, Omnium.Public.Products.Query.OmniumProductQueryRequestBase.Ids) when the ID type is known — they are more predictable.", "nullable": true }, "productParentIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Filter by parent product IDs", "nullable": true }, "productCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by product category IDs", "nullable": true }, "excludedProductCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from results", "nullable": true }, "excludedProductIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Product IDs to exclude from results", "nullable": true }, "gtins": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by GTIN codes (searches EAN, GTINS, and Units.EAN on products and variants)", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by product tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags to exclude from results", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by external IDs", "nullable": true }, "supplierIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by supplier IDs", "nullable": true }, "supplierSkuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by supplier SKU IDs", "nullable": true }, "seoUris": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by SEO URIs", "nullable": true }, "componentIds": { "type": "array", "items": { "type": "string" }, "description": "Filter by component IDs (returns products containing any of the specified component IDs)", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by promotion IDs (returns products with active prices matching any of the specified promotion IDs)", "nullable": true }, "assortmentCodeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Filter by assortment code IDs", "nullable": true }, "ignoreCustomerAssortment": { "type": "boolean", "description": "If true, the customer's assortment codes from the price context will not be applied as a filter" }, "isAssortmentCodesRequired": { "type": "boolean", "description": "When true, the product must have a matching assortment code. When null, uses the tenant configuration default.", "nullable": true }, "productType": { "type": "string", "description": "Filter by product type", "nullable": true }, "isActive": { "type": "boolean", "description": "True: only active products. False: only inactive products. Null: both.", "nullable": true }, "isSku": { "type": "boolean", "description": "True: only SKU products (without variants). False: only non-SKU products. Null: both.", "nullable": true }, "isBundle": { "type": "boolean", "description": "True: only bundle products. False: only non-bundles. Null: both.", "nullable": true }, "isPackage": { "type": "boolean", "description": "True: only package products. False: only non-packages. Null: both.", "nullable": true }, "isDeleted": { "type": "boolean", "description": "True: only deleted products. False: only non-deleted products. Null (default): both.", "nullable": true }, "isInStock": { "type": "boolean", "description": "True: only products in stock. False: only products not in stock. Null: both.\r\nShould be combined with InStockWarehouseIds or InStockMarketIds for specific filtering.", "nullable": true }, "isOnSale": { "type": "boolean", "description": "True: only products on sale. False: only products not on sale. Null: both.", "nullable": true }, "isPublished": { "type": "boolean", "description": "True: only products published today. Null: no publication filter.", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "True: only main product variants. Null: both.", "nullable": true }, "isAvailableOnline": { "type": "boolean", "description": "True: only products available online. False: only products not available online. Null: both.", "nullable": true }, "isLocalProduct": { "type": "boolean", "description": "True: only local products. False: only non-local products. Null: both.\r\nOnly relevant when IsLocalProductsEnabled is enabled in product settings.", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Filter products modified on or after this date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Filter products modified on or before this date", "format": "date-time", "nullable": true }, "startPublishFrom": { "type": "string", "description": "Filter products published on or after this date", "format": "date-time", "nullable": true }, "startPublishTo": { "type": "string", "description": "Filter products published on or before this date", "format": "date-time", "nullable": true }, "stopPublishFrom": { "type": "string", "description": "Filter products with publication end date on or after this date", "format": "date-time", "nullable": true }, "stopPublishTo": { "type": "string", "description": "Filter products with publication end date on or before this date", "format": "date-time", "nullable": true }, "priceFrom": { "type": "number", "description": "Filter products with price greater than or equal to this value.\r\nUses the first market from MarketIds for price resolution.", "format": "decimal", "nullable": true }, "priceTo": { "type": "number", "description": "Filter products with price less than or equal to this value.\r\nUses the first market from MarketIds for price resolution.", "format": "decimal", "nullable": true }, "priceActivatedFrom": { "type": "string", "description": "Filter products with prices activated on or after this date", "format": "date-time", "nullable": true }, "priceActivatedTo": { "type": "string", "description": "Filter products with prices activated on or before this date", "format": "date-time", "nullable": true }, "priceDeactivatedFrom": { "type": "string", "description": "Filter products with prices deactivated on or after this date", "format": "date-time", "nullable": true }, "priceDeactivatedTo": { "type": "string", "description": "Filter products with prices deactivated on or before this date", "format": "date-time", "nullable": true }, "isUnionDeltaQuery": { "type": "boolean", "description": "When true, uses OR logic for delta queries: returns products modified OR with price changes.\r\nWhen false (default), uses AND logic.", "nullable": true }, "productLanguage": { "type": "string", "description": "Language code (e.g. \"en\", \"no\", \"es\") for filtering product content", "nullable": true }, "ignoreLanguageFilter": { "type": "boolean", "description": "When true, ignores language filtering and searches across all languages.\r\nWhen false/null, uses the specified ProductLanguage. If no language is specified\r\nand markets are provided, resolves language from the market.", "nullable": true }, "inStockWarehouseIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Warehouse IDs for the IsInStock filter. If not set, IsInStock matches any warehouse.", "nullable": true }, "inStockMarketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Market IDs for the IsInStock filter. If not set, IsInStock matches any market.", "nullable": true }, "includeInventoryForSelectedStores": { "type": "boolean", "description": "When true, inventory data for selected stores is included in the response", "nullable": true }, "properties": { "maxLength": 20, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Filter products by custom property key/value pairs (AND semantics — products must match\r\nALL listed property pairs to be included). Each entry is a (key, value) pair on the product's\r\nProperties collection. Useful for narrowing by attributes like Color, Size, Brand, etc.", "nullable": true }, "excludedProperties": { "maxLength": 20, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Exclude products matching any of these property key/value pairs. OR semantics — a product\r\nmatching any one excluded property is removed from the result.", "nullable": true }, "propertyListId": { "type": "string", "description": "Property list ID controlling which properties are RETURNED in the response (response shaping,\r\nnot filtering). Uses predefined named property lists from tenant settings — only properties\r\nwhose keys are in the named list will be present on the returned products.", "nullable": true }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet definitions to include in the response. When null or empty, no facets are returned.", "nullable": true }, "fields": { "$ref": "#/components/schemas/OmniumProductFieldSelection" }, "completionRate": { "$ref": "#/components/schemas/OmniumCompletionRateFilter" }, "sort": { "maxLength": 10, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSortField" }, "description": "Sort fields in priority order. Each entry specifies a field name and direction (\"asc\" or \"desc\").\r\nAvailable field names are entity-specific (e.g. \"price\", \"name\", \"modified\" for products).", "nullable": true } }, "additionalProperties": false, "description": "Request model for the scroll product Query endpoint (POST /api/products/Query/Scroll).\r\nInherits all product filter fields from Omnium.Public.Products.Query.OmniumProductQueryRequestBase; adds\r\nscroll batch sizing.\r\n \r\nUse this for bulk extraction — full-catalog syncs to other systems (PIM, ERP, marketplace),\r\ndata exports, search-index reindexing pipelines. For UI-style paginated queries, use\r\nOmnium.Public.Products.Query.OmniumProductQueryRequest with the regular Query endpoint instead." }, "OmniumProductSearchBoostedProperty": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "boostValue": { "type": "number", "format": "double" }, "isSearchable": { "type": "boolean" } }, "additionalProperties": false }, "OmniumProductSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items pr page", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch", "format": "int32" }, "marketId": { "type": "string", "description": "Search by market. Only prices valid for market will be returned", "nullable": true }, "marketGroupId": { "type": "string", "description": "Search by market group. Only products", "nullable": true }, "marketIds": { "type": "array", "items": { "type": "string" }, "description": "Search by markets. Only prices valid for the markets will be returned", "nullable": true }, "marketGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Search by market groups.", "nullable": true }, "storeId": { "type": "string", "description": "Search by store. Only products available for store, and prices valid for store will be returned", "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "description": "Search by stores. Only products available for stores, and prices valid for stores will be returned", "nullable": true }, "storeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Search by store groups. Only products available for the stores in the store groups, and prices valid for stores will be returned", "nullable": true }, "storeIdPriceFilter": { "type": "string", "description": "Only prices valid for store will be returned", "nullable": true }, "priceFrom": { "type": "number", "description": "Search for products with price above FromPrice", "format": "decimal", "nullable": true }, "priceTo": { "type": "number", "description": "Search for products with price below ToPrice", "format": "decimal", "nullable": true }, "priceActivatedFrom": { "type": "string", "description": "Search for products with prices that became valid (activated) on or after this date/time", "format": "date-time", "nullable": true }, "priceActivatedTo": { "type": "string", "description": "Search for products with prices that became valid (activated) on or before this date/time", "format": "date-time", "nullable": true }, "priceDeactivatedFrom": { "type": "string", "description": "Search for products with prices that became invalid (deactivated) on or after this date/time", "format": "date-time", "nullable": true }, "priceDeactivatedTo": { "type": "string", "description": "Search for products with prices that became invalid (deactivated) on or before this date/time", "format": "date-time", "nullable": true }, "isUnionDeltaQuery": { "type": "boolean", "description": "When true, uses OR logic: returns products that are either modified since ModifiedFrom OR have prices that became active in PriceActivatedFrom/To range OR have prices that became inactive in PriceDeactivatedFrom/To range.\r\nWhen false (default), uses AND logic (current behavior).", "nullable": true }, "customerId": { "type": "string", "description": "Search by customer ID. Only prices valid for customer will be returned", "nullable": true }, "customerGroup": { "type": "string", "description": "Obsolete! Please use CustomerGroups instead. | Search by customer group. Only prices valid for customer group will be returned", "nullable": true, "deprecated": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by customer groups. Only prices valid for customer group will be returned", "nullable": true }, "searchText": { "maxLength": 200, "type": "string", "description": "Search text", "nullable": true }, "productIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Search by product ids", "nullable": true }, "productParentIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "Search by product parent ids", "nullable": true }, "productCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by category ids", "nullable": true }, "gtins": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by gtins on product. This searches for matches on fields EAN, GTINS and Units.EAN both on product and variants", "nullable": true }, "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Product facets", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of excluded tag names", "nullable": true }, "productType": { "type": "string", "description": "Product type", "nullable": true }, "isFacetsDisabled": { "type": "boolean", "description": "If set to true, facets (aggregations) will not be created and returned in the search request. Should always be set if you do not need facets as it will both speed up the search request and reduce the response size.", "nullable": true }, "sortOrder": { "type": "string", "description": "Primary (1st) sort order.\r\nList of options can be found in docs: https://docs.omnium.no/docs/Product/product-api#sort-order", "nullable": true }, "sortOrder2nd": { "type": "string", "description": "Secondary (2nd) sort order - if set, primary sort order (SortOrder) is required", "nullable": true }, "sortOrder3rd": { "type": "string", "description": "Tertiary (3rd) sort order - if set, primary (SortOrder) and secondary (SortOrder2nd) sort order is required", "nullable": true }, "sortIndexThreshold": { "type": "integer", "description": "If set result will not contain products with sort index lower than threshold", "format": "int32", "nullable": true }, "isActive": { "type": "boolean", "description": "True will only return active products. False will return both active and inactive products." }, "isInactive": { "type": "boolean", "description": "True will only return inactive products. Ignored if IsActive == true." }, "isSku": { "type": "boolean", "description": "True will only return products that are SKUs (products without variants). False will only return products that are not SKUs.", "nullable": true }, "isBundle": { "type": "boolean", "description": "True will only return products that are bundles.", "nullable": true }, "isPackage": { "type": "boolean", "description": "True will only return products that are packages.", "nullable": true }, "isDeleted": { "type": "boolean", "description": "True will only return deleted products (Status == \"Deleted\"). Value is false by default, only returning products that are not deleted." }, "isInStock": { "type": "boolean", "description": "True returns products in stock. False returns products not in stock. Null returns both. Should be combined with InStockMarketIds or InStockWarehouseIds for additional filtering.", "nullable": true }, "inStockMarketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Select which market(s) the IsInStock filter should be applied to. If not set, IsInStock will return true if any market has the item in stock.", "nullable": true }, "inStockWarehouseIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Select which warehouse(s) the IsInStock filter should be applied to. If not set, IsInStock will return true if any warehouse has the item in stock.", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "True returns only main variants.", "nullable": true }, "isOnSale": { "type": "boolean", "description": "True returns products on sale. False returns products not on sale. Null returns both.", "nullable": true }, "isCostOnSale": { "type": "boolean", "description": "Only works if separate cost prices are enabled in the configuration. True returns products with cost on sale. False returns products with cost not on sale. Null returns both.", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of promotion IDs. Return only products with active prices with any of the promotion IDs.", "nullable": true }, "property": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "modifiedFrom": { "type": "string", "description": "Products modified from date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Products modified before date", "format": "date-time", "nullable": true }, "isPricesExcluded": { "type": "boolean", "description": "If true, prices are searched, parsed and sorted in Omnium, but the price list is not returned", "nullable": true }, "excludedFields": { "$ref": "#/components/schemas/OmniumExcludedProductFieldOptions" }, "includedFields": { "$ref": "#/components/schemas/OmniumIncludedFieldsOptions" }, "daysSincePublished": { "type": "integer", "description": "Number of days since published. This will replace StartPublishFrom date.", "format": "int32", "nullable": true }, "startPublishFrom": { "type": "string", "description": "Products published from date", "format": "date-time", "nullable": true }, "startPublishTo": { "type": "string", "description": "Products published to date", "format": "date-time", "nullable": true }, "stopPublishFrom": { "type": "string", "description": "Products stopped published from date", "format": "date-time", "nullable": true }, "stopPublishTo": { "type": "string", "description": "Products stopped published from date", "format": "date-time", "nullable": true }, "isPublished": { "type": "boolean", "description": "|\r\n If true - only returns products published today", "nullable": true }, "productLanguage": { "type": "string", "description": "Language code e.g. en, no, es", "nullable": true }, "isProductLanguageFilterIgnored": { "type": "boolean", "description": "Ignore product language filter. If \"ProductLanguage\" is not specified in the request, we use the selected market's productContentLanguage with fallback to default product language. Set this option to true if you wish to search on all languages.", "nullable": true }, "excludedProductIds": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "List of specified product Ids to exclude.\r\nTypically used if you want to search for sibling products (with a common parent ID) but you'll want to exclude the products you already have.", "nullable": true }, "propertyListId": { "type": "string", "description": "Property list ID - Predefined property lists in settings for filtering", "nullable": true }, "supplierIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by supplier.", "nullable": true }, "supplierSkuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by supplier skuIds.", "nullable": true }, "assortmentCodeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Search by assortment codes.", "nullable": true }, "ignoreCustomerAssortment": { "type": "boolean", "description": "If set to 'true', the customer in product search context's assortment codes will not be used in the product search." }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search products with external IDs", "nullable": true }, "isAssortmentCodesRequired": { "type": "boolean", "description": "When true, the product must have an assortment that matches one of the provided assortment codes and if the product search request does not include any assortment codes, only products without assortment codes are returned.\r\nIf null, the system defaults to the 'IsAssortmentStoreIdRequired' configuration setting.", "nullable": true }, "assortmentCodeEvaluationDate": { "type": "string", "description": "Explicit override for the date used to evaluate AssortmentCode ValidFrom/ValidTo windows on customer\r\nand product assortments. When null the search falls back to Omnium.Public.Products.Search.OmniumProductSearchRequest.RequestedDeliveryDate and\r\nthen to the current UTC time. Compared at minute granularity.", "format": "date-time", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "The requested delivery date for this search context. When set, assortment-code validity is evaluated\r\nagainst this date instead of the current time, so products whose assortment becomes valid only after\r\nthis date (or expires before it) are filtered accordingly. Overridden by\r\nOmnium.Public.Products.Search.OmniumProductSearchRequest.AssortmentCodeEvaluationDate when both are provided. Treated as unset when null.", "format": "date-time", "nullable": true }, "componentIds": { "type": "array", "items": { "type": "string" }, "description": "Search for products by component IDs. Returns all products that contain any of the specified IDs in their component-related properties (e.g., skuId, productId).", "nullable": true }, "isAvailableOnline": { "type": "boolean", "description": "When true, returns only products that are available online (have stock in online-enabled warehouses).\r\nWhen false, returns only products not available online.\r\nWhen null (default), returns both.", "nullable": true }, "excludedProductCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from search results. Products in these categories will not be returned.", "nullable": true }, "seoUris": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by SEO URI(s)", "nullable": true }, "completionRate": { "$ref": "#/components/schemas/OmniumCompletionRateFilter" }, "isLocalProduct": { "type": "boolean", "description": "Only relevant when IsLocalProductsEnabled is enabled in productSettings. Filter by local product", "nullable": true } }, "additionalProperties": false, "description": "Search request object for products" }, "OmniumProductSearchSettings": { "type": "object", "properties": { "isInStockBoosted": { "type": "boolean" }, "inStockBoosting": { "type": "number", "format": "double" }, "isPromotionBoosted": { "type": "boolean" }, "promotionBoosting": { "type": "number", "format": "double" }, "isPopularityBoosted": { "type": "boolean" }, "popularityBoosting": { "type": "number", "format": "double" }, "isPricesExcludedFromSearch": { "type": "boolean" }, "isFuzzinessAuto": { "type": "boolean" }, "aggregationSize": { "type": "integer", "format": "int32" }, "prefixBoost": { "type": "number", "format": "double" }, "boostedProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductSearchBoostedProperty" }, "nullable": true } }, "additionalProperties": false }, "OmniumProductSettings": { "type": "object", "properties": { "readOnly": { "type": "boolean" }, "showFilters": { "type": "boolean" }, "rootCategoryId": { "type": "string", "nullable": true }, "productContentLanguages": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductContentLanguage" }, "nullable": true }, "seasonCategoryId": { "type": "string", "nullable": true }, "productFacets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductFacet" }, "nullable": true }, "hasPackages": { "type": "boolean" }, "isProductStatisticsEnabled": { "type": "boolean" }, "isProductOptionsEnabled": { "type": "boolean" }, "isDefaultPriceOverridingPrices": { "type": "boolean" }, "defaultProductCostCurrency": { "type": "string", "nullable": true }, "currencies": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "isIncompleteProductsEnabled": { "type": "boolean" }, "isProductLanguagesEnabled": { "type": "boolean" }, "isAssortmentStoreIdRequired": { "type": "boolean" }, "isOmniumUrlProviderEnabled": { "type": "boolean" }, "isOmniumSortIndexProviderEnabled": { "type": "boolean" }, "omniumUrlProviderTemplate": { "type": "string", "nullable": true }, "priceManagement": { "type": "boolean" }, "isPriceUpdateOperationDelayed": { "type": "boolean" }, "isVariantPricesJoined": { "type": "boolean" }, "isProductPriceSetToLowestVariantPrice": { "type": "boolean", "description": "If set to true, product price will be updated to the lowest variant price when the product is enriched." }, "isUpdatePricesAlwaysMarkedAsModified": { "type": "boolean", "description": "Set to true to force price updates with new \"Modified\" date, even if price has not changed" }, "isLocationEqualForAllVariants": { "type": "boolean" }, "hasExternalPrices": { "type": "boolean" }, "hasCustomerSpecificPrices": { "type": "boolean" }, "isVariantSearchEnabled": { "type": "boolean" }, "relatedProductKeys": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "imageAspectRatios": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAspectRatio" }, "nullable": true }, "isImagesAutoResizedOnUpload": { "type": "boolean" }, "imageMaxSize": { "$ref": "#/components/schemas/OmniumAspectRatio" }, "assetPurposeKeys": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "defaultProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDefaultPropertyItem" }, "nullable": true }, "highlightedProperties": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "productSearchSettings": { "$ref": "#/components/schemas/OmniumProductSearchSettings" }, "isTableStorageDisabled": { "type": "boolean" }, "productTypes": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductTypeItem" }, "nullable": true }, "tagSettings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTagSettings" }, "nullable": true } }, "additionalProperties": false }, "OmniumProductStatisticsSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items pr page", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch", "format": "int32" }, "from": { "type": "string", "description": "Date to search from", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "Date to search to", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID", "nullable": true }, "searchText": { "type": "string", "description": "Search text", "nullable": true }, "productIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product facets", "nullable": true } }, "additionalProperties": false, "description": "Search request object for products" }, "OmniumProductStatusUpdate": { "type": "object", "properties": { "skuId": { "type": "string", "description": "SKU ID of the product to update", "nullable": true }, "status": { "type": "string", "description": "New status for this specific product (e.g. Active, Cancelled)", "nullable": true }, "cancellationCode": { "type": "string", "description": "Cancellation/complaint code for this product", "nullable": true }, "cancellationReason": { "type": "string", "description": "Free text cancellation/complaint reason", "nullable": true } }, "additionalProperties": false, "description": "Status update for a single product in a project" }, "OmniumProductSupplier": { "type": "object", "properties": { "supplierName": { "type": "string", "description": "Name of product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Supplier ID", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier, used when creating purchase orders", "nullable": true } }, "additionalProperties": false }, "OmniumProductTypeItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "productTypeItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumInheritablePropertyItem" }, "nullable": true } }, "additionalProperties": false }, "OmniumProductUnit": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit (E.g. lbs, kg, pcs, etc...)", "nullable": true }, "conversionFactor": { "type": "number", "description": "Conversion factor (number of this unit in main product unit)", "format": "decimal" }, "supplierSkuId": { "type": "string", "description": "Supplier sku ID", "nullable": true }, "basePriceUnit": { "type": "boolean", "description": "If true, this unit is main unit", "nullable": true }, "ean": { "type": "string", "description": "Unit EAN / GTIN", "nullable": true }, "length": { "type": "number", "description": "Unit length", "format": "decimal", "nullable": true }, "width": { "type": "number", "description": "Unit width", "format": "decimal", "nullable": true }, "height": { "type": "number", "description": "Unit height", "format": "decimal", "nullable": true }, "volume": { "type": "number", "description": "Unit volume in dm2", "format": "decimal", "nullable": true }, "weight": { "type": "number", "description": "Unit weight", "format": "decimal", "nullable": true }, "unitType": { "type": "string", "description": "Unit type (F-pack / D-pack)", "nullable": true }, "isSupplierUnit": { "type": "boolean", "description": "True if unit is a supplier unit", "nullable": true }, "isConsumerUnit": { "type": "boolean", "description": "True if unit is a consumer unit", "nullable": true } }, "additionalProperties": false, "description": "Model for additional product units with conversion factor" }, "OmniumProductUpdateResult": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "notFoundIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true }, "isModified": { "type": "boolean" } }, "additionalProperties": false }, "OmniumProductVariant": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Product unique SKU (but equal for all language versions).", "nullable": true }, "isSku": { "type": "boolean", "description": "", "readOnly": true }, "id": { "type": "string", "description": "Required for products: Product unique ID. If your product catalog has multiple languages, the ID should be set with the following convention {ProductId}_{Language} ('12345_en').\r\nFor variants, the ID will be populated from SkuID, and should not be set manually.\r\nValid format: Only letters (a-z, A-Z), digits (0-9), hyphens (-), and underscores (\\_).\r\nRegex pattern: ^[a-zA-Z0-9\\-_]+$", "nullable": true }, "ean": { "type": "string", "description": "EAN code", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN codes", "nullable": true }, "productId": { "type": "string", "description": "Unique product Id, without language conventions.\r\nVariants on a product should have the same value for ProductId as the product has.", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "productGroup": { "$ref": "#/components/schemas/OmniumProductGroup" }, "startDate": { "type": "string", "description": "Product activation date. Product is not active if date is in the future.\r\nObsolete - Use Published property instead", "format": "date-time", "deprecated": true }, "endDate": { "type": "string", "description": "Product activation end date. Product is not active if date is in the past.\r\nObsolete - Use StopPublished property instead", "format": "date-time", "deprecated": true }, "created": { "type": "string", "description": "Date product is created", "format": "date-time" }, "modified": { "type": "string", "description": "Date product is modified", "format": "date-time" }, "published": { "type": "string", "description": "Date product is published", "format": "date-time" }, "stopPublished": { "type": "string", "description": "Product activation end date. Can be null", "format": "date-time", "nullable": true }, "discontinued": { "type": "string", "description": "Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "True if product is active. False if it should be hidden from customers." }, "catalog": { "type": "string", "description": "Label to categorize or group products. In Omnium this is used to show statistics grouped by this label. (This property is unrelated to the category tree.)", "nullable": true }, "mainCategoryId": { "type": "string", "description": "This is the main category for the product, and should be one of the CategoryIds in Categories. If Catalog is not used, this category's name will be used as grouping in statistics. If the main category is missing from the category list, it will automatically be added.", "nullable": true }, "mainCategoryName": { "type": "string", "description": "Calculated field: If MainCategoryId is given, and exists as a category in Omnium, this property will be overwritten by the name of that category.", "nullable": true }, "categories": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Product categories. If category enrichment is turned on, only CategoryId are required when adding or updating products. The other information will be populated from the already existing category with the same id.", "nullable": true }, "mainImageUrl": { "type": "string", "description": "Product main image url. If not set, this will be populated from the product assets, using the asset which has 'IsMainImage=\"true\"' set. If none are set, the first asset in the list is selected.", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product media files", "nullable": true }, "seoInformation": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "description": "Product information for search engine optimization\r\nObsolete - Use SeoInfo instead", "nullable": true, "deprecated": true }, "seoInfo": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "entryType": { "type": "string", "description": "Product entry type", "nullable": true, "deprecated": true }, "isBundle": { "type": "boolean", "description": "True if product is a bundle of other products (unlike package, price is sum of components)" }, "isKit": { "type": "boolean", "description": "True if product is a pre-assembled kit made of other products (unlike package and bundle, kits have inventory)" }, "isPackage": { "type": "boolean", "description": "True if product is package of other products (unlike bundle, price is specified for package)" }, "isWriteProtected": { "type": "boolean", "description": "True if product is write protected by user. PIM integrations should not override product information." }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "A list of errors (or warnings) for the product.\r\nTypically this is used in integrations where there was a problem export products. The errors are searchable and displayed in Omnium's UI", "nullable": true }, "isInStock": { "type": "boolean", "description": "Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes." }, "availableInventory": { "type": "number", "description": "Calculated: Number of items available in stock. If this is a product with variants, it will be a sum of all variants.\r\nThis is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.", "format": "decimal" }, "inventory": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductInventory" }, "description": "Calculated: This is populated automatically by default based on inventory and updated by a scheduled task which updates the products every 30 minutes.\r\nThe inventory list contains inventory information for each warehouse(store) defined in Omnium", "nullable": true }, "inventoryStatus": { "type": "string", "description": "Status of current inventory, based on AvailableInventory. Could be 'OutOfStock', 'LowInStock' or 'HighInStock'", "nullable": true }, "omniStock": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Calculated: List of store IDs where this product is available online (has stock and meets business rules for online sales)", "nullable": true }, "omniStockLevels": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOmniStockLevel" }, "description": "Calculated: Stock levels per store, used for online availability.", "nullable": true }, "warehouseInventories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumWarehouseInventory" }, "description": "Warehouse inventories\r\nObsolete - Use Inventory api endpoint instead", "nullable": true, "deprecated": true }, "catalogNodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Catalog nodes/categories. Simple list of strings of category names. Consider using the Categories property instead as this also contains IDs and category metadata.", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity (point of reordering)", "format": "decimal", "deprecated": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity (what should be in stock after new supply)", "format": "decimal", "deprecated": true }, "weight": { "type": "number", "description": "Product weight in kilograms (kg)", "format": "double", "nullable": true }, "taxCategory": { "type": "string", "description": "Product tax category", "nullable": true, "deprecated": true }, "taxGroupCode": { "type": "string", "description": "References a TaxGroup.Code in the tenant's chart of tax groups.\r\nWhen null, the tenant's DefaultTaxGroupCode applies (if feature is enabled).\r\nHas no effect when AccountingSettings.TaxGroupsEnabled = false.", "nullable": true }, "taxRate": { "type": "number", "description": "Per-product VAT rate used as a fallback when tax groups are not configured.\r\nApplied to any price that has no TaxRate of its own at save time.\r\nTax-group resolution takes precedence when enabled.", "format": "decimal", "nullable": true }, "siblings": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of sibling product IDs\r\nObsolete - Use RelatedProducts instead", "nullable": true, "deprecated": true }, "associatedProducts": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Associated product IDs\r\nObsolete - Use RelatedProducts instead", "nullable": true, "deprecated": true }, "price": { "$ref": "#/components/schemas/OmniumPrice" }, "prices": { "maxLength": 3000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of all product prices - all currencies, campaigns, customer prices etc", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of tags.", "nullable": true }, "marketIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "List of available market IDs. If not set, the product will be available for all markets.", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available store IDs. If not set, the product will be available for all stores.", "nullable": true }, "marketGroupIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available market group IDs", "nullable": true }, "language": { "type": "string", "description": "Product language code. This should match 'ProductContentLanguage' on a stored market in Omnium. Typically the values would be 'en' (english) or 'no' (norwegian).", "nullable": true }, "location": { "type": "string", "description": "The location of the product in the warehouse.", "nullable": true }, "color": { "type": "string", "description": "Product color", "nullable": true }, "brand": { "type": "string", "description": "Product brand", "nullable": true }, "size": { "type": "string", "description": "Product size", "nullable": true }, "shortDescription": { "type": "string", "description": "Short product description", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true }, "specification": { "type": "string", "description": "Product Specification", "nullable": true }, "averageRating": { "type": "number", "description": "Calculated - Average rating for this product", "format": "double" }, "ratingCount": { "type": "integer", "description": "Calculated - Number of ratings for this product", "format": "int32" }, "isNotRatable": { "type": "boolean", "description": "Set to true if this product should be excluded from rating emails/forms", "nullable": true }, "excludeFromPromotions": { "type": "boolean", "description": "Set to true if this product should be excluded from promotions", "nullable": true }, "salesStartDate": { "type": "string", "description": "Embargo date: product cannot be sold before this date", "format": "date-time", "nullable": true }, "fixedPriceCode": { "type": "string", "description": "Price protection category (e.g. book law)", "nullable": true }, "fixedPriceEndDate": { "type": "string", "description": "Discounts are blocked until this date", "format": "date-time", "nullable": true }, "discountBlocked": { "type": "boolean", "description": "Permanent discount prohibition", "nullable": true }, "isExcludedFromAnalytics": { "type": "boolean", "description": "Set to true if this product should be excluded from analytics (e.g., gift cards that would inflate sales figures)" }, "supplierName": { "type": "string", "description": "Name of main product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Main supplier ID", "nullable": true }, "supplierColor": { "type": "string", "description": "Color from supplier", "nullable": true }, "supplierPackagingUnit": { "type": "string", "description": "Unit for supplier sku", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity (D-Pack)", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "additionalSuppliers": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductSupplier" }, "description": "List of additional suppliers", "nullable": true }, "leadTime": { "type": "integer", "description": "Lead time in days", "format": "int32", "nullable": true }, "supplierLeadTime": { "type": "integer", "description": "Supplier lead time in days", "format": "int32", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier, used when creating purchase orders", "nullable": true }, "freightClass": { "type": "string", "description": "Freight class", "nullable": true }, "sizeType": { "type": "string", "description": "Product size type", "nullable": true }, "unit": { "type": "string", "description": "Product unit, used for describing what unit the quantities are in", "nullable": true }, "units": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductUnit" }, "description": "List of additional units", "nullable": true }, "colli": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductColli" }, "description": "List of colli, used for shipment", "nullable": true }, "relatedProducts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProduct" }, "description": "Related products", "nullable": true }, "season": { "type": "string", "description": "Product season", "nullable": true }, "badges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductBadge" }, "description": "List of product badges or labels to display on product", "nullable": true }, "sortIndex": { "type": "integer", "description": "Calculated sort index", "format": "int32", "readOnly": true }, "sortIndexBoost": { "type": "integer", "description": "Sort index set by API / GUI", "format": "int32" }, "sortIndexBase": { "type": "integer", "description": "Calculated sort index base set by Omnium services", "format": "int32" }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock" }, "isPriceLocked": { "type": "boolean", "description": "When true, the price on order lines created from this product will be locked and not recalculated." }, "isMainProductVariant": { "type": "boolean", "description": "If true, this variant should represent the product in flattened variant lists.\r\nThis can also be used if you have a product catalog with multiple products with the same parent ID set, and you only wish to show one of the products in product searches. You could then set this to 'false' on the products you wish to exclude from searches,\r\nand filter on the value." }, "isSerializableProduct": { "type": "boolean", "description": "If true, the product is serializable, and order line should contain serial number when completed" }, "isRental": { "type": "boolean", "description": "If true, the product is available for rental" }, "rentalSourceProductId": { "type": "string", "description": "The SKU ID of the original product this rental product was created from", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name", "nullable": true }, "popularityStandardSortIndex": { "$ref": "#/components/schemas/OmniumCustomSortIndex" }, "popularitySortIndices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomSortIndex" }, "description": "Calculated: List of market specific popularity indices", "nullable": true }, "cost": { "type": "number", "description": "Product net cost", "format": "decimal" }, "costCurrency": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "costInDefaultCurrency": { "type": "number", "description": "Cost in default currency", "format": "decimal", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components (used when product is a package)", "nullable": true }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOption" }, "description": "Available product options for the product", "nullable": true }, "productType": { "type": "string", "description": "Optional: Specifies if this product is of a specific kind.\r\nAn example of this is the type \"ProductOption\"\r\nA Product Option is a sold as an additional item or service to an other product, and is not sold by itself.\r\nInscriptions or other types of customization could be this sort of option.\r\nIt could also be a service, such as assembling, or it could be an additional item which would not make sense so sell on it's own", "nullable": true }, "promotionIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotions associated with the product", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external product IDs. Could be ids in eCommerce platform etc", "nullable": true }, "locationOverstock": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Overstock locations (extra inventory locations)", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Virtual products will not affect inventory.", "nullable": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "countryOfOrigin": { "type": "string", "description": "Country of origin", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the product", "nullable": true }, "lowestPriceHistory": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPriceReference" }, "description": "Price history (lowest prices for each market)", "nullable": true }, "assortmentCodes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAssortmentCode" }, "description": "Assortment codes for the product", "nullable": true }, "expectedDeliveryDate": { "type": "string", "description": "Date when the product is expected back in stock. Calculated by purchase order services, or set externally.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "Status is set by Omnium. \"Published\" is default. When delete a product in GUI. Status will be updated to \"Deleted\"", "nullable": true }, "completionStatus": { "$ref": "#/components/schemas/OmniumCompletionStatus" } }, "additionalProperties": false, "description": "Product variant" }, "OmniumProductVariantOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductVariant" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProject": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Project ID. Is set by Omnium.", "nullable": true }, "projectNumber": { "type": "string", "description": "Project number", "nullable": true }, "versionId": { "type": "string", "description": "Project version", "nullable": true }, "externalReference": { "type": "string", "description": "An external reference to project (optional)", "nullable": true }, "name": { "type": "string", "description": "Project name", "nullable": true }, "publicUrl": { "type": "string", "description": "URL to public project website", "nullable": true }, "storeId": { "type": "string", "description": "Store handling the project", "nullable": true }, "stores": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectStore" }, "description": "Additional stores with access to project", "nullable": true }, "customer": { "$ref": "#/components/schemas/OmniumProjectCustomer" }, "type": { "type": "string", "description": "Project type ID", "nullable": true }, "subType": { "type": "string", "description": "Project subtype", "nullable": true }, "status": { "type": "string", "description": "Project status (Active / Completed / New etc). Populate from constant class OmniumProjectStatus.", "nullable": true }, "projectTypeName": { "type": "string", "description": "Name of project's project type.", "nullable": true }, "workflowStep": { "$ref": "#/components/schemas/OmniumProjectWorkflowStep" }, "storeContact": { "$ref": "#/components/schemas/OmniumContactPerson" }, "contactPersons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons", "nullable": true }, "logItems": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" }, "description": "Log items (tracking each step in the project process) (Obsolete - can be fetched from ProjectLog-endpoints)", "nullable": true, "deprecated": true }, "partner": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "partners": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPartner" }, "description": "Project partners (used if project type supports multiple partners)", "nullable": true }, "hasMultiplePartners": { "type": "boolean", "description": "True if project has more than one partner", "readOnly": true }, "formData": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" }, "description": "Custom project data (e.g. from at public form)", "nullable": true }, "comments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Comments only visible to partners", "nullable": true }, "customerComments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Comments visible to customers", "nullable": true }, "created": { "type": "string", "description": "Date project is created (UTC)", "format": "date-time" }, "modified": { "type": "string", "description": "Date project is modified (UTC)", "format": "date-time" }, "workflowSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectWorkflowStep" }, "description": "All project workflow steps", "nullable": true }, "deadline": { "type": "string", "description": "Deadline based on current workflow step (UTC)", "format": "date-time", "nullable": true }, "projectDate": { "type": "string", "description": "Describing the date when the main activity of the project is performed.", "format": "date-time", "nullable": true }, "rentalFrom": { "type": "string", "description": "Rental period start date (UTC). Only set for rental projects.", "format": "date-time", "nullable": true }, "rentalTo": { "type": "string", "description": "Rental return date (UTC). The return day is not counted as a rental day. Only set for rental projects.", "format": "date-time", "nullable": true }, "isRentalProject": { "type": "boolean", "description": "True if this project tracks a rental lifecycle" }, "canceled": { "type": "string", "description": "Cancellation date of the project.", "format": "date-time", "nullable": true }, "attachments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "File attachments to project", "nullable": true }, "attachmentsRootDirectory": { "type": "string", "description": "Blob storage root directory for attachments on this project", "nullable": true }, "projectCategory": { "type": "string", "description": "Project category (e.g. Claim, Service)", "nullable": true }, "rejectedByPartners": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of partnerIds for partners who have rejected a project", "nullable": true }, "partnerCheckList": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectCheckListItem" }, "description": "Project checklist", "nullable": true }, "cancellationCode": { "type": "string", "description": "Cancellation code - reason for cancelling project", "nullable": true }, "cancellationReason": { "type": "string", "description": "Reason for cancelling project - free text", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external project IDs", "nullable": true }, "addresses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Project addresses", "nullable": true }, "projectValue": { "type": "number", "description": "Project value (Calculated if project has transactions)", "format": "decimal" }, "projectAdditionalValue": { "type": "number", "description": "Additional project value. To manually adjust project value. Will be added to project value together with the transaction values.", "format": "decimal" }, "projectBudgetValue": { "type": "number", "description": "Project budget value (Calculated if project has transactions)", "format": "decimal" }, "projectParts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts / sections", "nullable": true }, "changeOrders": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders", "nullable": true }, "transactions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project level transactions", "nullable": true }, "transactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "projectTransactionTotal": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Project tags", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectProductReference" }, "description": "Products associated with the project", "nullable": true } }, "additionalProperties": false, "description": "Class containing information for projects, e.g. a claim from a customer, or a service provided to an end customer" }, "OmniumProjectCancelRequest": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID", "nullable": true }, "cancellationCode": { "type": "string", "description": "Cancellation code", "nullable": true }, "cancellationReason": { "type": "string", "description": "Cancellation reason", "nullable": true }, "comment": { "type": "string", "description": "Comment", "nullable": true }, "cancelledBy": { "type": "string", "description": "The party who cancelled the project", "nullable": true } }, "additionalProperties": false }, "OmniumProjectChangeOrder": { "type": "object", "properties": { "approved": { "type": "string", "description": "Approved date", "format": "date-time" }, "approvedBy": { "type": "string", "description": "Approved by", "nullable": true }, "title": { "type": "string", "description": "Project part title", "nullable": true }, "description": { "type": "string", "description": "Description of project part", "nullable": true }, "status": { "type": "string", "description": "Project part status [Sent, Rejected, Approved, Cancelled]", "nullable": true }, "id": { "type": "string", "description": "Project part unique identifier", "nullable": true }, "tasks": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTask" }, "description": "Tasks for project part", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "cartIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Cart IDs connected to project part", "nullable": true }, "created": { "type": "string", "description": "Date created", "format": "date-time" }, "modified": { "type": "string", "description": "Date modified", "format": "date-time" }, "transactions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project part level transactions", "nullable": true }, "transactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "additionalProperties": false, "description": "Project change order" }, "OmniumProjectCheckListItem": { "type": "object", "properties": { "text": { "type": "string", "description": "Description of task", "nullable": true }, "comment": { "type": "string", "description": "Comment on performed task", "nullable": true }, "completed": { "type": "string", "description": "Date and time task was completed", "format": "date-time", "nullable": true }, "completedById": { "type": "string", "description": "ID of user performing task", "nullable": true }, "completedByName": { "type": "string", "description": "Name of user performing task", "nullable": true }, "isCompleted": { "type": "boolean", "description": "Is task completed?" } }, "additionalProperties": false, "description": "Project type check list item for tasks to be performed on each project" }, "OmniumProjectCustomer": { "required": [ "customerId" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of company", "nullable": true }, "taxId": { "type": "string", "description": "Tax ID, or other governmental identification number", "nullable": true }, "contacts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons in company", "nullable": true }, "creditBalance": { "type": "number", "description": "Customer's credit balance", "format": "decimal", "nullable": true }, "creditLimit": { "type": "number", "description": "Customer's credit limit", "format": "decimal", "nullable": true }, "creditRemaining": { "type": "number", "description": "Customer's remaining credits", "format": "decimal", "nullable": true }, "discountGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of customers discount groups", "nullable": true }, "priceGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of customers price groups", "nullable": true }, "logo": { "$ref": "#/components/schemas/OmniumAsset" }, "isAssortmentRestricted": { "type": "boolean", "description": "Set to 'true' if the business customer has a restricted assortment.\r\nThis is controlled by prices. If the customer has a customer specific price for a product, the product is automatically included in the customer's assortment.\r\nIf this is set to 'false', a non-customer specific price will be sufficient for the product to be part of the customer's assortment.", "nullable": true }, "firstName": { "type": "string", "description": "First name", "nullable": true }, "lastName": { "type": "string", "description": "Last name", "nullable": true }, "fullName": { "type": "string", "description": "Calculated - Full name", "nullable": true, "readOnly": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "birthDate": { "type": "string", "description": "Date of birth", "format": "date-time", "nullable": true }, "discountCoupons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscountCoupon" }, "description": "Personal discount coupons", "nullable": true }, "isCustomerClubMember": { "type": "boolean", "description": "True if customer is part of customer club" }, "bonusPoints": { "type": "integer", "description": "Number of bonus points earned by customer", "format": "int32" }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tags for customer", "nullable": true }, "customerId": { "type": "string", "description": "Unique ID" }, "customerNumber": { "type": "string", "description": "Customer identifier - does not have to be unique for each store, etc", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 200, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Customer additional addresses", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "url": { "type": "string", "description": "Customer url", "nullable": true }, "storeIds": { "maxLength": 500, "type": "array", "items": { "type": "string" }, "description": "Customer favorite stores", "nullable": true }, "marketId": { "type": "string", "description": "Customer primary market", "nullable": true }, "additionalMarketIds": { "maxLength": 100, "type": "array", "items": { "type": "string" }, "description": "Additional customer markets (beyond the primary MarketId)", "nullable": true }, "marketGroupId": { "type": "string", "description": "Customer market group", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Preferred customer language code", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Customer preferred currency code (E.g. USD, NOK, EUR)", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external customer IDs", "nullable": true }, "isGlobal": { "type": "boolean", "description": "If true, customer is available in all markets / stores", "nullable": true }, "modifiedBy": { "type": "string", "description": "Name of the user or system the last modified the item", "nullable": true }, "created": { "type": "string", "description": "Date and time the customer was created", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date and time the customer was modified", "format": "date-time", "nullable": true }, "isInactive": { "type": "boolean", "description": "True if customer is inactive, and should not be able to make purchases", "nullable": true }, "preferredShippingMethod": { "type": "string", "description": "Customer's preferred shipping method name (default selected in new carts)", "nullable": true }, "paymentTerms": { "type": "string", "description": "Payment terms (free text)", "nullable": true }, "paymentTermsNet": { "type": "integer", "description": "Net payment terms (days)", "format": "int32", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Customer groups", "nullable": true }, "consents": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsent" }, "description": "Customer consents", "nullable": true }, "consentHistory": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumConsentHistory" }, "description": "Consent history", "nullable": true }, "customerDetails": { "type": "string", "description": "Customer details (brief summary for customer service representatives)", "nullable": true }, "customerRelations": { "maxLength": 2000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerRelation" }, "description": "Related customers", "nullable": true }, "assortmentIncludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to include in customer's assortment. Only products in these categories will be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true }, "assortmentExcludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Product category IDs to exclude from customer's assortment. Products in these categories will not be available to the customer.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true } }, "additionalProperties": false, "description": "Project customer (private or business)" }, "OmniumProjectDailyReport": { "type": "object", "properties": { "storeName": { "type": "string", "nullable": true }, "storeId": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "unclarifiedProjects": { "type": "integer", "format": "int32" }, "newProjects": { "type": "integer", "format": "int32" }, "completedProjects": { "type": "integer", "format": "int32" }, "cancelledProjects": { "type": "integer", "format": "int32" }, "projectTypeName": { "type": "string", "nullable": true }, "timeToComplete": { "type": "string", "example": "00:00:00" }, "timeToRespond": { "type": "string", "example": "00:00:00" } }, "additionalProperties": false, "description": "Daily project summary" }, "OmniumProjectFormEntry": { "type": "object", "properties": { "key": { "type": "string", "description": "Property key", "nullable": true }, "value": { "type": "string", "description": "Property value", "nullable": true }, "valueType": { "type": "string", "description": "Data type (Number, Xhtml, String, DateTime, Boolean, etc)", "nullable": true }, "keyGroup": { "type": "string", "description": "For grouping properties", "nullable": true } }, "additionalProperties": false, "description": "Key / values for additional project information" }, "OmniumProjectFormEntryAdvancedSearch": { "type": "object", "properties": { "projectFormEntriesAdvancedFilter": { "maxLength": 250, "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" } }, "description": "Advanced filters for filtering on form entries.\r\nThe inner list is AND-conditions and the outer lists will be OR", "nullable": true }, "excludedFormEntries": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" }, "description": "FormEntries to exclude", "nullable": true } }, "additionalProperties": false }, "OmniumProjectLog": { "type": "object", "properties": { "id": { "type": "string", "description": "Id", "nullable": true }, "projectId": { "type": "string", "description": "ProjectId", "nullable": true }, "text": { "type": "string", "description": "Logtext", "nullable": true }, "date": { "type": "string", "description": "Date log item is created", "format": "date-time" }, "comment": { "type": "string", "description": "Comment from customer", "nullable": true }, "user": { "type": "string", "description": "User updating project", "nullable": true }, "dueDate": { "type": "string", "description": "When the current workflow step is due", "format": "date-time", "nullable": true }, "dueText": { "type": "string", "description": "Comment of due date", "nullable": true }, "newWorkflowStepName": { "type": "string", "description": "New workflow step when project is updated", "nullable": true }, "previousWorkflowStepName": { "type": "string", "description": "The current / previous workflow step when project is updated", "nullable": true }, "hidden": { "type": "boolean", "description": "If true, log item should be hidden from customers or partners" }, "hiddenFromCustomer": { "type": "boolean", "description": "If true, log item should be hidden from customer" }, "hiddenFromPartner": { "type": "boolean", "description": "If true, log item should be hidden from partner" }, "data": { "type": "string", "description": "Log data", "nullable": true } }, "additionalProperties": false, "description": "Project log items (added by Omnium upon project updates)" }, "OmniumProjectLogOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProjectLogSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "projectId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumProjectOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProject" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumProjectOmniumVersion": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/OmniumProject" } }, "additionalProperties": false }, "OmniumProjectPart": { "type": "object", "properties": { "title": { "type": "string", "description": "Project part title", "nullable": true }, "description": { "type": "string", "description": "Description of project part", "nullable": true }, "status": { "type": "string", "description": "Project part status [Sent, Rejected, Approved, Cancelled]", "nullable": true }, "id": { "type": "string", "description": "Project part unique identifier", "nullable": true }, "tasks": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTask" }, "description": "Tasks for project part", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "cartIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Cart IDs connected to project part", "nullable": true }, "created": { "type": "string", "description": "Date created", "format": "date-time" }, "modified": { "type": "string", "description": "Date modified", "format": "date-time" }, "transactions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project part level transactions", "nullable": true }, "transactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" } }, "additionalProperties": false, "description": "Project part" }, "OmniumProjectPartner": { "type": "object", "properties": { "id": { "type": "string", "description": "Partner ID (Omnium business customer)", "nullable": true }, "name": { "type": "string", "description": "Partner name", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Partner addresses", "nullable": true }, "email": { "type": "string", "description": "Partner email address", "nullable": true }, "phone": { "type": "string", "description": "Partner phone number", "nullable": true }, "contacts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Partner contact persons", "nullable": true }, "role": { "type": "string", "description": "Partner role (E.g. Carpenter)", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true } }, "additionalProperties": false }, "OmniumProjectPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Project ID. Is set by Omnium.", "nullable": true }, "projectNumber": { "type": "string", "description": "Project number", "nullable": true }, "versionId": { "type": "string", "description": "Project version", "nullable": true }, "externalReference": { "type": "string", "description": "An external reference to project (optional)", "nullable": true }, "name": { "type": "string", "description": "Project name", "nullable": true }, "publicUrl": { "type": "string", "description": "URL to public project website", "nullable": true }, "storeId": { "type": "string", "description": "Store handling the project", "nullable": true }, "stores": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectStore" }, "description": "Additional stores with access to project", "nullable": true }, "customer": { "$ref": "#/components/schemas/OmniumPrivateCustomer" }, "type": { "type": "string", "description": "Project type ID", "nullable": true }, "subType": { "type": "string", "description": "Project subtype", "nullable": true }, "status": { "type": "string", "description": "Project status (Active / Completed / New etc). Populate from constant class OmniumProjectStatus.", "nullable": true }, "workflowStep": { "$ref": "#/components/schemas/OmniumProjectWorkflowStep" }, "storeContact": { "$ref": "#/components/schemas/OmniumContactPerson" }, "contactPersons": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons", "nullable": true }, "logItems": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectLog" }, "description": "Log items (tracking each step in the project process)", "nullable": true }, "partner": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPartner" }, "description": "Project partners (used if project type supports multiple partners)", "nullable": true }, "hasMultiplePartners": { "type": "boolean", "description": "True if project has more than one partner", "nullable": true, "readOnly": true }, "formData": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" }, "description": "Custom project data (e.g. from at public form)", "nullable": true }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Comments only visible to partners", "nullable": true }, "customerComments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "Comments visible to customers", "nullable": true }, "created": { "type": "string", "description": "Date project is created (UTC)", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date project is modified (UTC)", "format": "date-time", "nullable": true }, "workflowSteps": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectWorkflowStep" }, "description": "All project workflow steps", "nullable": true }, "deadline": { "type": "string", "description": "Deadline based on current workflow step (UTC)", "format": "date-time", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "File attachments to project", "nullable": true }, "projectCategory": { "type": "string", "description": "Project category (e.g. Claim, Service)", "nullable": true }, "partnerCheckList": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectCheckListItem" }, "description": "Project checklist", "nullable": true }, "cancellationCode": { "type": "string", "description": "Cancellation code - reason for cancelling project", "nullable": true }, "cancellationReason": { "type": "string", "description": "Reason for cancelling project - free text", "nullable": true }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external project IDs", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Project tags", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Project addresses", "nullable": true }, "projectValue": { "type": "number", "description": "Project value (Calculated if project has transactions)", "format": "decimal", "nullable": true }, "projectBudgetValue": { "type": "number", "description": "Project budget value (Calculated if project has transactions)", "format": "decimal", "nullable": true }, "projectParts": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts / sections", "nullable": true }, "changeOrders": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders", "nullable": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project level transactions", "nullable": true }, "transactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "projectTransactionTotal": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectProductReference" }, "description": "Products associated with the project (replaces full product list when set)", "nullable": true } }, "additionalProperties": false, "description": "Class containing information for projects, e.g. a claim from a customer, or a service provided to an end customer" }, "OmniumProjectProductReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Product name", "nullable": true }, "referenceType": { "type": "string", "description": "Reference type (available reference types are defined on project type)", "nullable": true }, "orderType": { "type": "string", "description": "Order type the product is related to", "nullable": true }, "skuId": { "type": "string", "description": "Product SkuId", "nullable": true }, "productId": { "type": "string", "description": "Product Id", "nullable": true }, "lineItemId": { "type": "string", "description": "The line item ID from the originating order or purchase order", "nullable": true }, "quantity": { "type": "number", "description": "Number of products", "format": "decimal" }, "deliveredQuantity": { "type": "number", "description": "Number of products delivered", "format": "decimal" }, "canceledQuantity": { "type": "number", "description": "Number of products canceled", "format": "decimal" }, "status": { "type": "string", "description": "Product-level status (e.g. Active, Cancelled, Completed)", "nullable": true }, "returnReason": { "type": "string", "description": "Return reason from the originating return order line", "nullable": true }, "returnType": { "type": "string", "description": "Return type code from the originating return order line — usable for order-type mapping in downstream systems", "nullable": true }, "cancellationCode": { "type": "string", "description": "Complaint/cancellation reason code for this product", "nullable": true }, "cancellationReason": { "type": "string", "description": "Free text complaint/cancellation reason for this product", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for this product", "nullable": true }, "totalRentalDepositAmount": { "type": "number", "description": "Total deposit amount for rental product", "format": "decimal" }, "claimedRentalDepositAmount": { "type": "number", "description": "Amount to claim from the deposit, the amount that will not be refunded when the rental product is returned", "format": "decimal" }, "orderId": { "type": "string", "description": "The ID of the order this product is associated", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "The ID of the purchase order this product is associated", "nullable": true }, "rentalProductId": { "type": "string", "description": "The specific rental product instance SKU ID", "nullable": true }, "rentalFrom": { "type": "string", "description": "Rental period start for this product", "format": "date-time", "nullable": true }, "rentalTo": { "type": "string", "description": "Rental return date for this product", "format": "date-time", "nullable": true }, "dailyRate": { "type": "number", "description": "Daily rental rate", "format": "decimal" } }, "additionalProperties": false, "description": "Used for listing products associated to a project" }, "OmniumProjectSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "projectId": { "type": "string", "description": "Project ID", "nullable": true }, "projectNumber": { "type": "string", "description": "Project number", "nullable": true }, "stepName": { "type": "string", "description": "Filter by current step name", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "phone": { "type": "string", "description": "Customer phone number", "nullable": true }, "storeContact": { "type": "string", "description": "Search projects by store contact", "nullable": true }, "contactPersonEmails": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by contact person emails", "nullable": true }, "contactPersonPhones": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by contact person phone numbers", "nullable": true }, "customerId": { "type": "string", "description": "Customer name", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "postalCode": { "type": "string", "description": "Customer postal code", "nullable": true }, "addressFilter": { "$ref": "#/components/schemas/OmniumAddressSearchRequest" }, "city": { "type": "string", "description": "Customer city", "nullable": true }, "partnerName": { "type": "string", "description": "Partner name", "nullable": true }, "partnerId": { "type": "string", "description": "Partner ID", "nullable": true }, "statuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Statuses (E.g. New, Completed, WorkflowCompleted, CancelledByCustomer etc)", "nullable": true }, "query": { "type": "string", "description": "Search query", "nullable": true }, "createdFrom": { "type": "string", "description": "Project created after date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Project created before date", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Project modified after date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Project modified before date", "format": "date-time", "nullable": true }, "active": { "type": "boolean", "description": "Search only active projects" }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs", "nullable": true }, "projectTypeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Project type IDs", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order", "nullable": true }, "stepIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by current step ids", "nullable": true }, "excludeRejectedPartnerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by projects without rejected partner ids in list", "nullable": true }, "rejectedPartnerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter projects by rejected partner ids in list", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by external IDs", "nullable": true }, "externalIdsProvider": { "type": "string", "description": "If set, only external IDs with given provider is returned", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "excludeTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude projects with tags", "nullable": true }, "formEntries": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" }, "description": "Filter by form entries", "nullable": true }, "projectFormEntryAdvancedSearch": { "$ref": "#/components/schemas/OmniumProjectFormEntryAdvancedSearch" }, "isUrgent": { "type": "boolean", "description": "If true, only projects with expired workflow steps (urgent) are returned" }, "includeComments": { "type": "boolean", "description": "If true or null - attaches comments to projects before returning", "nullable": true } }, "additionalProperties": false }, "OmniumProjectStore": { "type": "object", "properties": { "storeId": { "type": "string", "description": "Store ID", "nullable": true }, "name": { "type": "string", "description": "Store name", "nullable": true }, "email": { "type": "string", "description": "Store email", "nullable": true }, "phone": { "type": "string", "description": "Store phone", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumStoreAddress" }, "role": { "type": "string", "description": "Store role in project", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Store properties", "nullable": true } }, "additionalProperties": false, "description": "Store referenced by project" }, "OmniumProjectTask": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the task", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Properties", "nullable": true }, "created": { "type": "string", "description": "Created", "format": "date-time", "nullable": true }, "text": { "type": "string", "description": "Description of task", "nullable": true }, "comment": { "type": "string", "description": "Comment on performed task", "nullable": true }, "completed": { "type": "string", "description": "Date and time task was completed", "format": "date-time", "nullable": true }, "completedById": { "type": "string", "description": "ID of user performing task", "nullable": true }, "completedByName": { "type": "string", "description": "Name of user performing task", "nullable": true }, "isCompleted": { "type": "boolean", "description": "Is task completed?" } }, "additionalProperties": false, "description": "Project task item" }, "OmniumProjectTransaction": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique transaction identifier", "nullable": true }, "description": { "type": "string", "description": "Transaction description", "nullable": true }, "revenue": { "type": "number", "description": "Transaction revenue (actual)", "format": "decimal" }, "cost": { "type": "number", "description": "Transaction cost (actual)", "format": "decimal" }, "value": { "type": "number", "description": "Transaction value (Calcualted)", "format": "decimal" }, "budgetRevenue": { "type": "number", "description": "Budget revenue", "format": "decimal" }, "budgetCost": { "type": "number", "description": "Budget cost", "format": "decimal" }, "budgetValue": { "type": "number", "description": "Budget value (Calculated)", "format": "decimal" }, "budgetDeviation": { "type": "number", "description": "Budget deviation (Calculated)", "format": "decimal" }, "budgetDeviationPercent": { "type": "number", "description": "Budget deviation in percent (Calculated)", "format": "decimal" } }, "additionalProperties": false, "description": "Project revenue or cost transaction" }, "OmniumProjectTransactionSummary": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Unique project identifier", "nullable": true }, "partsTransactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "changeTransactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "totalTransactionSummary": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "totalHits": { "type": "integer", "description": "Number of projects matching the search criteria", "format": "int64" } }, "additionalProperties": false, "description": "Project transaction summaries" }, "OmniumProjectType": { "type": "object", "properties": { "projectTypeId": { "type": "string", "description": "Unique project type ID", "nullable": true }, "projectTypeName": { "type": "string", "description": "Name of project type", "nullable": true }, "workflowSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectWorkflowStep" }, "description": "All steps defining the project workflow", "nullable": true }, "projectCategory": { "type": "string", "description": "Project type category (e.g. Claim, Service)", "nullable": true }, "partnerCheckList": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectCheckListItem" }, "description": "Project type checklist", "nullable": true }, "availablePartnerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Business customer IDs that can be related to project as partners", "nullable": true }, "isPartnerDisabled": { "type": "boolean", "description": "True if projects of this type cannot be assigned to partners" }, "active": { "type": "boolean", "description": "True if project type is active" }, "finishOnLastStep": { "type": "boolean", "description": "True if projects of this type should get status completed on last workflow step" }, "canHaveMultiplePartners": { "type": "boolean", "description": "True if project can have multiple partners" }, "internalCheckList": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectCheckListItem" }, "description": "Check list items for project type", "nullable": true }, "publicUrl": { "type": "string", "description": "Internal check list items for project type", "nullable": true }, "defaultOrderType": { "type": "string", "description": "Default order type for new carts created from projects", "nullable": true }, "setDeliveryAddressToMainStoreAddress": { "type": "boolean", "description": "Set cart delivery/billing address from project main store" }, "projectTypeDescription": { "type": "string", "description": "Description of the project type", "nullable": true }, "defaultProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDefaultPropertyItem" }, "description": "Default values for schema on project type", "nullable": true }, "terms": { "type": "string", "description": "Terms text for projects with project type", "nullable": true } }, "additionalProperties": false, "description": "A type of project, with definitions of workflow steps. Used as template when Omnium is creating new projects." }, "OmniumProjectTypePatch": { "type": "object", "properties": { "projectTypeId": { "type": "string", "description": "Unique project type ID", "nullable": true }, "projectTypeName": { "type": "string", "description": "Name of project type", "nullable": true }, "projectCategory": { "type": "string", "description": "Project type category (e.g. Claim, Service)", "nullable": true }, "availablePartnerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Business customer IDs that can be related to project as partners", "nullable": true }, "isPartnerDisabled": { "type": "boolean", "description": "True if projects of this type cannot be assigned to partners", "nullable": true }, "active": { "type": "boolean", "description": "True if project type is active", "nullable": true } }, "additionalProperties": false, "description": "Patch object for project types" }, "OmniumProjectTypeReport": { "type": "object", "properties": { "totalProjects": { "type": "integer", "description": "Total number of projects in the period (not deleted, not cancelled, not finished)", "format": "int32" }, "newProjects": { "type": "integer", "description": "Total number of projects created in the period", "format": "int32" }, "completedProjects": { "type": "integer", "description": "Total number of projects finished in the period", "format": "int32" }, "cancelledProjects": { "type": "integer", "description": "Total number of projects cancelled in the period", "format": "int32" }, "projectTypeName": { "type": "string", "description": "Project type", "nullable": true }, "timeToComplete": { "type": "string", "description": "Average completion time for completed projects", "example": "00:00:00" }, "timeToRespond": { "type": "string", "description": "Average response time for projects responded to", "example": "00:00:00" } }, "additionalProperties": false, "description": "Project type report" }, "OmniumProjectTypeReportRequest": { "required": [ "fromDate", "toDate" ], "type": "object", "properties": { "fromDate": { "type": "string", "description": "From date", "format": "date-time" }, "toDate": { "type": "string", "description": "To date", "format": "date-time" }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs", "nullable": true } }, "additionalProperties": false, "description": "Request for generating project type stats" }, "OmniumProjectUpdateRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Project ID. Is set by Omnium.", "nullable": true }, "projectNumber": { "type": "string", "description": "Project number", "nullable": true }, "externalReference": { "type": "string", "description": "An external reference to project (optional)", "nullable": true }, "name": { "type": "string", "description": "Project name", "nullable": true }, "publicUrl": { "type": "string", "description": "URL to public project website", "nullable": true }, "storeId": { "type": "string", "description": "Store handling the project", "nullable": true }, "customer": { "$ref": "#/components/schemas/OmniumProjectCustomer" }, "storeContact": { "$ref": "#/components/schemas/OmniumContactPerson" }, "contactPersons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Contact persons", "nullable": true }, "partner": { "$ref": "#/components/schemas/OmniumBusinessCustomer" }, "partners": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPartner" }, "description": "Project partners (used if project type supports multiple partners)", "nullable": true }, "formData": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectFormEntry" }, "description": "Custom project data (e.g. from at public form)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external project IDs", "nullable": true }, "addresses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Project addresses", "nullable": true }, "projectValue": { "type": "number", "description": "Project value", "format": "decimal", "nullable": true }, "projectParts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectPart" }, "description": "Project parts", "nullable": true }, "transactions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectTransaction" }, "description": "Project transactions", "nullable": true }, "changeOrders": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectChangeOrder" }, "description": "Project change orders", "nullable": true }, "stores": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectStore" }, "description": "Additional stores with access to project", "nullable": true }, "cancellationCode": { "type": "string", "description": "Cancellation code (should correspond to cancellation reasons in settings)", "nullable": true }, "cancellationReason": { "type": "string", "description": "Custom cancellation reason (free text)", "nullable": true }, "deadline": { "type": "string", "description": "Deadline based on current workflow step (UTC)", "format": "date-time", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Project tags", "nullable": true }, "products": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProjectProductReference" }, "description": "Products associated with the project", "nullable": true } }, "additionalProperties": false, "description": "Class used for updating projects" }, "OmniumProjectWorkflowStep": { "type": "object", "properties": { "id": { "type": "string", "description": "Step ID (provided by Omnium)", "nullable": true }, "index": { "type": "integer", "description": "Index (for sorting)", "format": "int32" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external order IDs", "nullable": true }, "name": { "type": "string", "description": "Name of the step", "nullable": true }, "description": { "type": "string", "description": "Description of the step (what should be done by users during this step)", "nullable": true }, "acceptText": { "type": "string", "description": "Text on accept button (moving forward to the next step)", "nullable": true }, "declineText": { "type": "string", "description": "Text on decline button (moving backwards to the previous step)", "nullable": true }, "dateText": { "type": "string", "description": "Text describing a date input. User should be able to add date if this property has value.", "nullable": true }, "current": { "type": "boolean", "description": "True if this step is the current workflow step" }, "startDate": { "type": "string", "description": "Date the step was started", "format": "date-time", "nullable": true }, "dateCompleted": { "type": "string", "description": "Date the step was completed (if null, the step was never completed)", "format": "date-time", "nullable": true }, "hiddenFromCustomer": { "type": "boolean", "description": "If step should be hidden from customer" }, "hiddenFromPartner": { "type": "boolean", "description": "If step should be hidden from partner" }, "isCommentsDisabled": { "type": "boolean", "description": "If user should be able to enter comments on this step" } }, "additionalProperties": false, "description": "A single step of the project workflow" }, "OmniumPromotion": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "activeFrom": { "type": "string", "format": "date-time" }, "activeTo": { "type": "string", "format": "date-time" }, "costPriceActiveFrom": { "type": "string", "description": "Optional start date for cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "costPriceActiveTo": { "type": "string", "description": "Optional end date for cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveTo is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveFrom": { "type": "string", "description": "Optional start date for store cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveTo": { "type": "string", "description": "Optional end date for store cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveTo is used.", "format": "date-time", "nullable": true }, "markets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "marketGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "storeGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "stores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedStoreGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "filterOnWarehouseStores": { "type": "boolean" }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "nullable": true }, "privateCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "businessCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "promotionTranslations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionTranslation" }, "nullable": true }, "deactivated": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "promotionService": { "type": "string", "nullable": true }, "promotionData": { "$ref": "#/components/schemas/OmniumPromotionType" }, "couponCode": { "type": "string", "nullable": true }, "additionalCoupons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionCoupon" }, "nullable": true }, "canBeCombinedWithOtherPromotions": { "type": "boolean" }, "alwaysApply": { "type": "boolean" }, "customerClubMembersOnly": { "type": "boolean" }, "tenantId": { "type": "string", "nullable": true }, "indexIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "orderTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true }, "priceFilterMode": { "type": "string", "description": "Controls how the promotion filters products based on price type: None (default, no filtering), Exclude, or Include.", "nullable": true }, "priceTypeFilter": { "type": "string", "description": "Comma-separated flags indicating which price types to filter: Discounted, MemberPrice, or both (Discounted, MemberPrice).\r\nUsed with PriceFilterMode.", "nullable": true }, "useDiscountedPriceAsBase": { "type": "boolean", "description": "When true, the promotion discount is calculated from the discounted price instead of the original price." }, "convertToRegularPriceAt": { "type": "string", "description": "When set, indicates when the promotion price should be automatically converted to a regular price\r\nwith a \"Last Chance\" label. Typically set to promotion start date + 30 days.", "format": "date-time", "nullable": true }, "isConvertedToRegularPrice": { "type": "boolean", "description": "Whether this promotion has been converted to a regular price with Last Chance flag." }, "convertedToRegularPriceAt": { "type": "string", "description": "When the conversion to regular price was executed.", "format": "date-time", "nullable": true }, "forceGeneratePrices": { "type": "boolean", "description": "When true, price records are generated even if the promotion has coupon codes or order type restrictions.\r\nfalse and null both use default behavior.", "nullable": true }, "excludeFromLowestPriceHistory": { "type": "boolean", "description": "When true, prices generated by this promotion are excluded from the lowest price history calculation.\r\nfalse and null both use default behavior (included).", "nullable": true }, "createPriceList": { "type": "boolean", "description": "When true, a price list is automatically created with the same ID as the promotion.\r\nThe price list stores planning/budget data for non-PriceListPromotion types.", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionAdvancedReward": { "type": "object", "properties": { "isAdvancedRewardEnabled": { "type": "boolean", "description": "Is advanced reward settings enabled" }, "isDiscountMostExpensive": { "type": "boolean", "description": "Used on Multibuy if the most expensive product should be the one that will be discounted" }, "isDiscountLeastExpensive": { "type": "boolean", "description": "Used on Multibuy if the least expensive product should be the one that will be discounted" }, "discountUsageLimit": { "type": "integer", "description": "Number of times this discount can be applied on a cart. 0 is unlimited", "format": "int32" } }, "additionalProperties": false, "description": "" }, "OmniumPromotionAmount": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal" }, "currency": { "type": "string", "nullable": true }, "marketId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionAmountStep": { "type": "object", "properties": { "amount": { "type": "number", "description": "The fixed discount amount awarded when the order net total reaches AmountLimit.", "format": "decimal" }, "amountLimit": { "type": "number", "description": "The order net total threshold (lower limit) that must be reached for this step's Amount to apply.", "format": "decimal" }, "marketId": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionCoupon": { "type": "object", "properties": { "couponCode": { "type": "string", "description": "Customer coupon code", "nullable": true }, "canOnlyBeUsedOnce": { "type": "boolean", "description": "Set to true if the coupon is only valid for a single use" }, "used": { "type": "boolean", "description": "Set to true if the coupon is already used" } }, "additionalProperties": false, "description": "Represents a coupon for a promotion" }, "OmniumPromotionFixedPriceReward": { "type": "object", "properties": { "fixedPriceQuantity": { "type": "integer", "description": "The number of items required to qualify for the fixed price.\r\nExample: For \"4 items for 99\", set this to 4.", "format": "int32" }, "fixedPricePrice": { "type": "number", "description": "The total price for the bundle of items.\r\nExample: For \"4 items for 99\", set this to 99.\r\nThe discount is calculated as: (sum of original prices) - FixedPricePrice", "format": "decimal" } }, "additionalProperties": false, "description": "Configuration for fixed price promotions (e.g., \"4 items for 99.90\").\r\nUsed when the discount's RewardType is \"FixedPrice\".\r\nThe promotion calculator will prioritize items from highest to lowest price.\r\nExample: FixedPriceQuantity=4, FixedPricePrice=99.90 means \"Buy any 4 items from the promotion for 99.90 total\"" }, "OmniumPromotionKitComponentGroup": { "type": "object", "properties": { "requiredQuantity": { "type": "integer", "description": "Required quantity of items from this component group in the kit. (null == 1 or more).", "format": "int32", "nullable": true }, "discountedQuantity": { "type": "integer", "description": "Number of items from this component group that can be discounted in the kit (0 == discount all items).", "format": "int32" }, "categoryAndBrandFilter": { "$ref": "#/components/schemas/OmniumCategoryAndBrandFilter" }, "required": { "type": "boolean", "description": "Is this component group required to be present in the kit?" } }, "additionalProperties": false }, "OmniumPromotionKitReward": { "type": "object", "properties": { "promotionKitComponentGroups": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionKitComponentGroup" }, "description": "Component groups that make up the kit.", "nullable": true }, "rewardType": { "$ref": "#/components/schemas/KitPromotionRewardType" } }, "additionalProperties": false, "description": "Reward model for promotion kits (i.e., “Buy a one of each component and get a discount on the kit”)." }, "OmniumPromotionKitRewardPatch": { "type": "object", "properties": { "rewardType": { "$ref": "#/components/schemas/KitPromotionRewardType" } }, "additionalProperties": false, "description": "Reward patch model for kit promotions." }, "OmniumPromotionMultiBuyReward": { "type": "object", "properties": { "requiredBuyAmount": { "type": "integer", "description": "Number of items the customer must buy at full price to qualify for the discount.\r\nExample \"3 for 2\": Set to 2 (buy 2, get 1 free means you pay for 2)\r\nExample \"Buy 3, get 1 free\": Set to 3", "format": "int32" }, "numberOfDiscountedItems": { "type": "integer", "description": "Number of additional items that receive the discount when RequiredBuyAmount is met.\r\nExample \"3 for 2\": Set to 1 (1 item is free)\r\nExample \"Buy 3, get 2 at 50% off\": Set to 2", "format": "int32" }, "percentage": { "type": "number", "description": "The percentage discount applied to the discounted items (0-100).\r\nSet to 100 for \"free\" items.\r\nSet to 50 for \"50% off\" on the discounted items.\r\nExample \"3 for 2\": Set to 100 (the discounted item is free)", "format": "decimal" }, "promotionAmounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amounts for the promotion. Used for giving a fixed amount or fixed price discount.", "nullable": true }, "usePercentage": { "type": "boolean", "description": "Use percentage for the promotion. Set to true if the promotion should give a percentage discount. False if it should give a fixed amount discount." }, "isFixedPrice": { "type": "boolean", "description": "Set to true for fixed price promotions (e.g., \"3 for $99\"). When true, use PromotionAmounts to specify the fixed price.", "nullable": true }, "promotionAdvancedReward": { "$ref": "#/components/schemas/OmniumPromotionAdvancedReward" }, "useTieredPricing": { "type": "boolean", "description": "Enable quantity-based tiered pricing. When true, use QuantityTiers instead of single-tier settings.\r\nExample: \"2 for 499 NOK, 3 for 649 NOK, 4 for 799 NOK\"" }, "quantityTiers": { "maxLength": 50, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionQuantityTier" }, "description": "List of quantity-based tiers. Each tier defines a quantity threshold and its associated pricing.\r\nTiers must have unique quantities per market and should be sorted ascending by quantity.\r\nOnly used when UseTieredPricing is true.", "nullable": true }, "useConditionalPricing": { "type": "boolean", "description": "Enable conditional pricing behavior where promotional prices are only shown when condition is met" }, "conditionalPricing": { "$ref": "#/components/schemas/OmniumConditionalPricingSettings" } }, "additionalProperties": false, "description": "Configuration for multi-buy promotions (e.g., \"Buy 2, get 1 free\" / \"3 for 2\").\r\nUsed when the discount's RewardType is \"MultiBuys\".\r\nBy default, the calculator prioritizes items from lowest to highest price (cheapest item is discounted).\r\nThis can be changed with the SortMultibuyItemsDescending setting.\r\nExample \"3 for 2\": RequiredBuyAmount=2, NumberOfDiscountedItems=1, Percentage=100" }, "OmniumPromotionMultiBuyRewardPatch": { "type": "object", "properties": { "requiredBuyAmount": { "type": "integer", "description": "Required amount of items to buy to get a discount on additional items", "format": "int32", "nullable": true }, "numberOfDiscountedItems": { "type": "integer", "description": "Number of discounted items if required buy amount is fulfilled", "format": "int32", "nullable": true }, "percentage": { "type": "number", "description": "Percentage discount (0-100) when UsePercentage is true. Not used when IsFixedPrice is true (use PromotionAmounts instead).", "format": "decimal", "nullable": true }, "promotionAmounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amounts for the promotion. Used for giving a fixed amount discount.", "nullable": true }, "usePercentage": { "type": "boolean", "description": "Use percentage for the promotion. Set to true if the promotion should give a percentage discount. False if it should give a fixed amount discount.", "nullable": true }, "isFixedPrice": { "type": "boolean", "description": "Set to true for fixed price promotions (e.g., \"3 for $99\"). When true, use PromotionAmounts to specify the fixed price.", "nullable": true } }, "additionalProperties": false, "description": "Reward model for multi-buy promotions (i.e., \"2 for the price of 1\"). Only used if reward type is \"MultiBuys\"." }, "OmniumPromotionOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotion" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPromotionOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotion" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPromotionPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id of the promotion, GUID will be generated if not provided.", "nullable": true }, "name": { "type": "string", "description": "Name of the promotion", "nullable": true }, "title": { "type": "string", "description": "Descriptive title of the promotion", "nullable": true }, "activeFrom": { "type": "string", "description": "Start date of the promotion", "format": "date-time", "nullable": true }, "activeTo": { "type": "string", "description": "End date of the promotion.", "format": "date-time", "nullable": true }, "costPriceActiveFrom": { "type": "string", "description": "Optional start date for cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "costPriceActiveTo": { "type": "string", "description": "Optional end date for cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveTo is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveFrom": { "type": "string", "description": "Optional start date for store cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveTo": { "type": "string", "description": "Optional end date for store cost prices on the linked price list (PriceListPromotion).\r\nIf null, ActiveTo is used.", "format": "date-time", "nullable": true }, "markets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these markets.", "nullable": true }, "marketGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these market groups.", "nullable": true }, "stores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these stores.", "nullable": true }, "storeGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these store groups.", "nullable": true }, "excludedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion will not apply for carts with these stores. Exclude takes priority over include.", "nullable": true }, "excludedStoreGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion will not apply for carts with stores in these store groups. Exclude takes priority over include.", "nullable": true }, "filterOnWarehouseStores": { "type": "boolean", "description": "Only discount for products sent from chosen stores. (Only applies if stores are set). Default is false.", "nullable": true }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Promotion is only valid for customers in these customer groups.", "nullable": true }, "privateCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for these specific private (B2C) customers by ID.", "nullable": true }, "businessCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for these specific business (B2B) customers by ID.", "nullable": true }, "promotionTranslations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionTranslation" }, "description": "Title and Description translations for different markets.", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the promotion. Promotions with higher priority will be applied first. 0 is the highest priority.", "format": "int32", "nullable": true }, "promotionData": { "$ref": "#/components/schemas/OmniumPromotionTypePatch" }, "couponCode": { "type": "string", "description": "Coupon code for the promotion. If not set, the promotion will be applied automatically.", "nullable": true }, "additionalCoupons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionCoupon" }, "description": "Additional coupon codes for the promotion. (Personal coupon codes / single usage coupon codes).", "nullable": true }, "canBeCombinedWithOtherPromotions": { "type": "boolean", "description": "Promotion can be combined with other promotions on the same orderLine (e.g. 10% off + 5$ off).", "nullable": true }, "alwaysApply": { "type": "boolean", "description": "Promotion can be combined also with promotions that have are canBeCombinedWithOtherPromotions = false.", "nullable": true }, "customerClubMembersOnly": { "type": "boolean", "description": "Promotion is valid only for customers that are members of the customer club.", "nullable": true }, "isBonusPointsReward": { "type": "boolean", "description": "Is reward given in bonus points instead of discount (CustomerClub and CategoryOrBrand promotions only).", "nullable": true }, "orderTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is valid only for these order types (e.g. online, clickAndCollect, pos).", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tag for filtering promotions. E.g. \"BlackFriday\"", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Additional properties / meta data", "nullable": true }, "forcePriceUpdate": { "type": "boolean", "description": "Force update of all product prices for this promotion, regardless of whether changes are detected.\r\nThis will remove existing promotion prices and recalculate them based on the current promotion configuration.\r\nOnly applies to promotions where prices are not calculated in cart.", "nullable": true }, "priceFilterMode": { "type": "string", "description": "Controls how the promotion filters products based on price type: None (default, no filtering), Exclude, or Include.", "nullable": true }, "priceTypeFilter": { "type": "string", "description": "Comma-separated flags indicating which price types to filter: Discounted, MemberPrice, or both (Discounted, MemberPrice).\r\nUsed with PriceFilterMode.", "nullable": true }, "useDiscountedPriceAsBase": { "type": "boolean", "description": "When true, the promotion discount is calculated from the discounted price instead of the original price. Default is false.", "nullable": true }, "convertToRegularPriceAt": { "type": "string", "description": "When set, indicates when the promotion price should be automatically converted to a regular price\r\nwith a \"Last Chance\" label. Typically set to promotion start date + 30 days. Set to null to clear.", "format": "date-time", "nullable": true }, "forceGeneratePrices": { "type": "boolean", "description": "When true, price records are generated even if the promotion has coupon codes or order type restrictions.\r\nfalse and null both use default behavior.", "nullable": true }, "excludeFromLowestPriceHistory": { "type": "boolean", "description": "When true, prices generated by this promotion are excluded from the lowest price history calculation.\r\nfalse and null both use default behavior (included).", "nullable": true }, "createPriceList": { "type": "boolean", "description": "When true, a price list is automatically created with the same ID as the promotion.\r\nThe price list stores planning/budget data for non-PriceListPromotion types.", "nullable": true } }, "additionalProperties": false, "description": "Request for adding a promotion" }, "OmniumPromotionPatchUpdateResult": { "type": "object", "properties": { "isModified": { "type": "boolean" }, "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionPercentageStep": { "type": "object", "properties": { "percentage": { "type": "number", "format": "decimal" }, "amount": { "type": "number", "format": "decimal" }, "marketId": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionProduct": { "type": "object", "properties": { "productName": { "type": "string", "nullable": true }, "productId": { "type": "string", "nullable": true }, "isSku": { "type": "boolean" }, "parentId": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionQuantityTier": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "The quantity threshold for this tier (e.g., 2, 3, 4).\r\nCustomers must purchase at least this many items to qualify for this tier's pricing.", "format": "int32" }, "fixedPrice": { "type": "number", "description": "Fixed price for this quantity tier. Used when promotion IsFixedPrice is true.\r\nExample: For \"2 for 499\", this would be 499.", "format": "decimal" }, "percentage": { "type": "number", "description": "Discount percentage for this tier. Used when UsePercentage is true.\r\nValue should be between 0-100 (e.g., 20 for 20% off).", "format": "decimal" }, "discountAmount": { "type": "number", "description": "Discount amount per item for this tier.\r\nUsed when UsePercentage is false and IsFixedPrice is false.", "format": "decimal" }, "marketId": { "type": "string", "description": "Market ID for this tier (e.g., \"NO\", \"SE\", \"DK\").", "nullable": true }, "currency": { "type": "string", "description": "Currency for this tier (e.g., \"NOK\", \"SEK\", \"DKK\").", "nullable": true } }, "additionalProperties": false, "description": "Represents a quantity-based pricing tier for MultiBuy promotions in the public API.\r\nEnables tiered discounts like \"2 for 499 NOK, 3 for 649 NOK, 4 for 799 NOK\"." }, "OmniumPromotionRequest": { "required": [ "activeFrom", "activeTo", "markets" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id of the promotion, GUID will be generated if not provided.", "nullable": true }, "name": { "type": "string", "description": "Name of the promotion", "nullable": true }, "title": { "type": "string", "description": "Descriptive title of the promotion", "nullable": true }, "activeFrom": { "type": "string", "description": "Start date of the promotion", "format": "date-time" }, "activeTo": { "type": "string", "description": "End date of the promotion.", "format": "date-time" }, "costPriceActiveFrom": { "type": "string", "description": "Optional start date for cost prices on the linked price list. If null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "costPriceActiveTo": { "type": "string", "description": "Optional end date for cost prices on the linked price list. If null, ActiveTo is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveFrom": { "type": "string", "description": "Optional start date for store cost prices on the linked price list. If null, ActiveFrom is used.", "format": "date-time", "nullable": true }, "storeCostPriceActiveTo": { "type": "string", "description": "Optional end date for store cost prices on the linked price list. If null, ActiveTo is used.", "format": "date-time", "nullable": true }, "markets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these markets." }, "marketGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these market groups.", "nullable": true }, "storeGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these store groups.", "nullable": true }, "stores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for carts with these stores.", "nullable": true }, "excludedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion will not apply for carts with these stores. Exclude takes priority over include.", "nullable": true }, "excludedStoreGroups": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion will not apply for carts with stores in these store groups. Exclude takes priority over include.", "nullable": true }, "filterOnWarehouseStores": { "type": "boolean", "description": "Only discount for products sent from chosen stores. (Only applies if stores are set). Default is false." }, "customerGroups": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCustomerGroupReference" }, "description": "Promotion is only valid for customers in these customer groups.", "nullable": true }, "privateCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for these specific private (B2C) customers by ID.", "nullable": true }, "businessCustomerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is only valid for these specific business (B2B) customers by ID.", "nullable": true }, "promotionTranslations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionTranslation" }, "description": "Title and Description translations for different markets.", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the promotion. Promotions with higher priority will be applied first. 0 is the highest priority.", "format": "int32" }, "promotionData": { "$ref": "#/components/schemas/OmniumPromotionTypeRequest" }, "couponCode": { "type": "string", "description": "Coupon code for the promotion. If not set, the promotion will be applied automatically.", "nullable": true }, "additionalCoupons": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionCoupon" }, "description": "Additional coupon codes for the promotion. (Personal coupon codes / single usage coupon codes).", "nullable": true }, "canBeCombinedWithOtherPromotions": { "type": "boolean", "description": "Promotion can be combined with other promotions on the same orderLine (e.g. 10% off + 5$ off)." }, "alwaysApply": { "type": "boolean", "description": "Promotion can be combined also with promotions that have are canBeCombinedWithOtherPromotions = false." }, "customerClubMembersOnly": { "type": "boolean", "description": "Promotion is valid only for customers that are members of the customer club." }, "isBonusPointsReward": { "type": "boolean", "description": "Is reward given in bonus points instead of discount (CustomerClub and CategoryOrBrand promotions only)." }, "orderTypes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Promotion is valid only for these order types (e.g. online, clickAndCollect, pos).", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Tag for filtering promotions. E.g. \"BlackFriday\"", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Additional properties / meta data", "nullable": true }, "priceFilterMode": { "type": "string", "description": "Controls how the promotion filters products based on price type: None (default, no filtering), Exclude, or Include.", "nullable": true }, "priceTypeFilter": { "type": "string", "description": "Comma-separated flags indicating which price types to filter: Discounted, MemberPrice, or both (Discounted, MemberPrice).\r\nUsed with PriceFilterMode.", "nullable": true }, "useDiscountedPriceAsBase": { "type": "boolean", "description": "When true, the promotion discount is calculated from the discounted price instead of the original price. Default is false." }, "convertToRegularPriceAt": { "type": "string", "description": "When set, indicates when the promotion price should be automatically converted to a regular price\r\nwith a \"Last Chance\" label. Typically set to promotion start date + 30 days.", "format": "date-time", "nullable": true }, "forceGeneratePrices": { "type": "boolean", "description": "When true, price records are generated even if the promotion has coupon codes or order type restrictions.\r\nfalse and null both use default behavior.", "nullable": true }, "excludeFromLowestPriceHistory": { "type": "boolean", "description": "When true, prices generated by this promotion are excluded from the lowest price history calculation.\r\nfalse and null both use default behavior (included).", "nullable": true }, "createPriceList": { "type": "boolean", "description": "When true, a price list is automatically created with the same ID as the promotion.\r\nThe price list stores planning/budget data for non-PriceListPromotion types.", "nullable": true } }, "additionalProperties": false, "description": "Request for adding a promotion" }, "OmniumPromotionReward": { "type": "object", "properties": { "percentageSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionPercentageStep" }, "description": "Percentage steps for the promotion. Used for giving increasing discounts based on the amount spent.", "nullable": true }, "amountSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmountStep" }, "description": "Amount steps for the promotion. Used for giving increasing fixed amount discounts based on the amount spent.", "nullable": true }, "promotionAmounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amounts for the promotion. Used for giving a fixed amount discount.", "nullable": true }, "percentage": { "type": "number", "description": "Percentage for the promotion. Used for giving a percentage discount.", "format": "decimal" }, "usePercentage": { "type": "boolean", "description": "Use percentage for the promotion. Set to true if the promotion should give a percentage discount. False if it should give a fixed amount discount." } }, "additionalProperties": false, "description": "Reward for a promotion" }, "OmniumPromotionRewardPatch": { "type": "object", "properties": { "percentageSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionPercentageStep" }, "description": "Percentage steps for the promotion. Used for giving increasing discounts based on the amount spent.", "nullable": true }, "amountSteps": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmountStep" }, "description": "Amount steps for the promotion. Used for giving increasing fixed amount discounts based on the amount spent.", "nullable": true }, "promotionAmounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amounts for the promotion. Used for giving a fixed amount discount.", "nullable": true }, "percentage": { "type": "number", "description": "Percentage for the promotion. Used for giving a percentage discount.", "format": "decimal", "nullable": true }, "usePercentage": { "type": "boolean", "description": "Use percentage for the promotion. Set to true if the promotion should give a percentage discount. False if it should give a fixed amount discount.", "nullable": true } }, "additionalProperties": false, "description": "Reward for a promotion" }, "OmniumPromotionScrollSearchRequest": { "type": "object", "properties": { "scrollSize": { "type": "integer", "description": "Number of items per scroll batch. Default applied when null: 500. Allowed range: 100–1000.", "format": "int32", "nullable": true }, "activatedBeforeDate": { "type": "string", "description": "Promotions that have started before this date.\r\nOnly promotions where {Promotion.ActiveFrom <= activatedBeforeDate} will be included.", "format": "date-time", "nullable": true }, "endedAfterDate": { "type": "string", "description": "Promotions that will end after this date.\r\nOnly promotions where {Promotion.ActiveTo >= endedAfterDate} will be included.", "format": "date-time", "nullable": true }, "activeFrom": { "type": "string", "description": "Promotions that will become active after this date.\r\nOnly promotions where {Promotion.ActiveFrom >= activeFrom} will be included.", "format": "date-time", "nullable": true }, "activeTo": { "type": "string", "description": "Promotions that will end before this date.\r\nOnly promotions where {Promotion.ActiveTo <= activeTo} will be included.", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Only return promotions modified on or after this date.\r\nUseful for delta queries / polling for changes.", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Only return promotions modified on or before this date.", "format": "date-time", "nullable": true }, "createdFrom": { "type": "string", "description": "Only return promotions created on or after this date.\r\nUseful for delta queries / polling for newly created promotions.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Only return promotions created on or before this date.", "format": "date-time", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of marketids to filter on", "nullable": true }, "promotionTypes": { "type": "array", "items": { "type": "string" }, "description": "List of promotion types to filter on.\r\nValid types: ShippingPromotion, CategoryOrBrandPromotion, ProductSearchPromotion,\r\nPriceListPromotion, MultibuyPromotion, OrderAmountPromotion, KitPromotion", "nullable": true } }, "additionalProperties": false, "description": "Request model for the scroll promotion search endpoint (POST /api/Promotions/Search/Scroll).\r\nInherits all promotion filter fields from Omnium.Public.Promotions.Search.OmniumPromotionSearchRequestBase; adds\r\nscroll batch sizing.\r\n \r\nUse this for bulk extraction — exporting large promotion sets, syncing to other systems. The\r\nresponse returns a ScrollId; pass it to GET /api/Promotions/Scroll/{id} to fetch subsequent\r\nbatches until no ScrollId is returned. For UI-style paginated search, use\r\nOmnium.Public.Promotions.Search.OmniumPromotionSearchRequest with the regular search endpoint instead." }, "OmniumPromotionSearchRequest": { "type": "object", "properties": { "page": { "type": "integer", "description": "Page number, fallback to 1", "format": "int32" }, "take": { "type": "integer", "description": "Number of elements, fallback to 10", "format": "int32" }, "activatedBeforeDate": { "type": "string", "description": "Promotions that have started before this date.\r\nOnly promotions where {Promotion.ActiveFrom <= activatedBeforeDate} will be included.", "format": "date-time", "nullable": true }, "endedAfterDate": { "type": "string", "description": "Promotions that will end after this date.\r\nOnly promotions where {Promotion.ActiveTo >= endedAfterDate} will be included.", "format": "date-time", "nullable": true }, "activeFrom": { "type": "string", "description": "Promotions that will become active after this date.\r\nOnly promotions where {Promotion.ActiveFrom >= activeFrom} will be included.", "format": "date-time", "nullable": true }, "activeTo": { "type": "string", "description": "Promotions that will end before this date.\r\nOnly promotions where {Promotion.ActiveTo <= activeTo} will be included.", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Only return promotions modified on or after this date.\r\nUseful for delta queries / polling for changes.", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Only return promotions modified on or before this date.", "format": "date-time", "nullable": true }, "createdFrom": { "type": "string", "description": "Only return promotions created on or after this date.\r\nUseful for delta queries / polling for newly created promotions.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Only return promotions created on or before this date.", "format": "date-time", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of marketids to filter on", "nullable": true }, "promotionTypes": { "type": "array", "items": { "type": "string" }, "description": "List of promotion types to filter on.\r\nValid types: ShippingPromotion, CategoryOrBrandPromotion, ProductSearchPromotion,\r\nPriceListPromotion, MultibuyPromotion, OrderAmountPromotion, KitPromotion", "nullable": true } }, "additionalProperties": false, "description": "Request model for the paginated promotion search endpoint (POST /api/Promotions/Search).\r\nInherits all promotion filter fields from Omnium.Public.Promotions.Search.OmniumPromotionSearchRequestBase; adds\r\npagination controls.\r\n \r\nFor bulk extraction of large result sets (exports, system syncs), use\r\nOmnium.Public.Promotions.Search.OmniumPromotionScrollSearchRequest with the scroll endpoint instead." }, "OmniumPromotionSelectedShipmentMethods": { "type": "object", "properties": { "marketId": { "type": "string", "nullable": true }, "shippingMethodNames": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumPromotionTranslation": { "type": "object", "properties": { "market": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumPromotionType": { "type": "object", "properties": { "promotionType": { "type": "string", "nullable": true }, "calculateProductPricesCouponCodeNotApplied": { "type": "boolean" }, "totalHits": { "type": "integer", "format": "int64" }, "lastPriceUpdate": { "type": "string", "format": "date-time", "nullable": true }, "reward": { "$ref": "#/components/schemas/OmniumPromotionReward" }, "shippingMethods": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionSelectedShipmentMethods" }, "nullable": true }, "amountCondition": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "nullable": true }, "categoryAndBrandFilter": { "$ref": "#/components/schemas/OmniumCategoryAndBrandFilter" }, "promotionMultiBuyReward": { "$ref": "#/components/schemas/OmniumPromotionMultiBuyReward" }, "discountedCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "nullable": true }, "discountedProducts": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionProduct" }, "nullable": true }, "productSearchRequest": { "$ref": "#/components/schemas/OmniumProductSearchRequest" }, "minQuantity": { "type": "integer", "description": "Minimum total quantity of items required in the order (Only applies if PromotionType is OrderAmountPromotion).", "format": "int32", "nullable": true }, "conditionOperator": { "$ref": "#/components/schemas/OmniumConditionOperator" }, "promotionKitReward": { "$ref": "#/components/schemas/OmniumPromotionKitReward" }, "priceListId": { "type": "string", "description": "The Id of the price list to use for this promotion (Applies to PriceListPromotion and CostPricePromotion).\r\nFor CostPricePromotion, the price list provides cost prices used as the discount base.", "nullable": true }, "markupPercentage": { "type": "number", "description": "Percentage markup added to the cost price (Only applies if PromotionType is CostPricePromotion).", "format": "decimal" }, "useStoreCostPrice": { "type": "boolean", "description": "When true, uses the StoreCostPrice from the price list item instead of the supplier cost price (Only applies if PromotionType is CostPricePromotion)." } }, "additionalProperties": false }, "OmniumPromotionTypePatch": { "type": "object", "properties": { "promotionType": { "$ref": "#/components/schemas/PromotionType" }, "reward": { "$ref": "#/components/schemas/OmniumPromotionRewardPatch" }, "shippingMethods": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionSelectedShipmentMethods" }, "description": "Defines the shipping methods that the promotion is valid for (Only applies if PromotionType is ShippingPromotion).", "nullable": true }, "amountCondition": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amount conditions for the promotion (Only applies if PromotionType is ShippingPromotion).", "nullable": true }, "categoryAndBrandFilter": { "$ref": "#/components/schemas/OmniumCategoryAndBrandFilter" }, "promotionMultiBuyReward": { "$ref": "#/components/schemas/OmniumPromotionMultiBuyRewardPatch" }, "discountedCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Discounted categories for Mix and match promotions. E.g buy one item of category A, get one item of category B free. (Only applies if PromotionType is MultiBuyPromotion).", "nullable": true }, "discountedProducts": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionProduct" }, "description": "Discounted products for Mix and match promotions. E.g buy one item of product or category A, get one item of product B free. (Only applies if PromotionType is MultiBuyPromotion).", "nullable": true }, "productSearchRequest": { "$ref": "#/components/schemas/OmniumProductSearchRequest" }, "minQuantity": { "type": "integer", "description": "Minimum total quantity of items required in the order (Only applies if PromotionType is OrderAmountPromotion).", "format": "int32", "nullable": true }, "conditionOperator": { "$ref": "#/components/schemas/OmniumConditionOperator" }, "promotionKitReward": { "$ref": "#/components/schemas/OmniumPromotionKitRewardPatch" }, "priceListId": { "type": "string", "description": "The Id of the price list to use for this promotion (Applies to PriceListPromotion and CostPricePromotion).\r\nFor CostPricePromotion, the price list provides cost prices used as the discount base.", "nullable": true }, "markupPercentage": { "type": "number", "description": "Percentage markup added to the cost price (Only applies if PromotionType is CostPricePromotion).", "format": "decimal", "nullable": true }, "useStoreCostPrice": { "type": "boolean", "description": "When true, uses the StoreCostPrice from the price list item instead of the supplier cost price (Only applies if PromotionType is CostPricePromotion).", "nullable": true } }, "additionalProperties": false, "description": "Promotion type data" }, "OmniumPromotionTypeRequest": { "type": "object", "properties": { "promotionType": { "$ref": "#/components/schemas/PromotionType" }, "reward": { "$ref": "#/components/schemas/OmniumPromotionReward" }, "shippingMethods": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionSelectedShipmentMethods" }, "description": "Defines the shipping methods that the promotion is valid for (Only applies if PromotionType is ShippingPromotion).", "nullable": true }, "amountCondition": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionAmount" }, "description": "Amount conditions for the promotion (Applies to ShippingPromotion and OrderAmountPromotion).\r\nFor ShippingPromotion: minimum order amount for free/discounted shipping.\r\nFor OrderAmountPromotion: minimum order amount for the promotion to apply.", "nullable": true }, "categoryAndBrandFilter": { "$ref": "#/components/schemas/OmniumCategoryAndBrandFilter" }, "promotionMultiBuyReward": { "$ref": "#/components/schemas/OmniumPromotionMultiBuyReward" }, "discountedCategories": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductCategory" }, "description": "Discounted categories for Mix and match promotions. E.g buy one item of category A, get one item of category B free. (Only applies if PromotionType is MultiBuyPromotion).", "nullable": true }, "discountedProducts": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPromotionProduct" }, "description": "Discounted products for Mix and match promotions. E.g buy one item of product or category A, get one item of product B free. (Only applies if PromotionType is MultiBuyPromotion).", "nullable": true }, "promotionKitReward": { "$ref": "#/components/schemas/OmniumPromotionKitReward" }, "productSearchRequest": { "$ref": "#/components/schemas/OmniumProductSearchRequest" }, "minQuantity": { "type": "integer", "description": "Minimum total quantity of items required in the order (Only applies if PromotionType is OrderAmountPromotion).", "format": "int32", "nullable": true }, "conditionOperator": { "$ref": "#/components/schemas/OmniumConditionOperator" }, "priceListId": { "type": "string", "description": "The Id of the price list to use for this promotion (Applies to PriceListPromotion and CostPricePromotion).\r\nFor CostPricePromotion, the price list provides cost prices used as the discount base.", "nullable": true }, "markupPercentage": { "type": "number", "description": "Percentage markup added to the cost price (Only applies if PromotionType is CostPricePromotion).\r\nExample: 10 means a 10% markup on the cost price.", "format": "decimal", "nullable": true }, "useStoreCostPrice": { "type": "boolean", "description": "When true, uses the StoreCostPrice from the price list item instead of the supplier cost price (Only applies if PromotionType is CostPricePromotion).", "nullable": true } }, "additionalProperties": false, "description": "Promotion type data" }, "OmniumPropertyItem": { "type": "object", "properties": { "key": { "type": "string", "description": "Property key", "nullable": true }, "value": { "type": "string", "description": "Property value", "nullable": true }, "valueType": { "type": "string", "description": "Data type (Number, Xhtml, String, DateTime, Boolean, etc)", "nullable": true }, "keyGroup": { "type": "string", "description": "For grouping properties", "nullable": true } }, "additionalProperties": false, "description": "Generic property item (key values)" }, "OmniumPropertyOption": { "required": [ "group", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier (auto-generated GUID if omitted on create).", "nullable": true }, "group": { "maxLength": 100, "type": "string", "description": "Group key. Stored normalized (lowercase, trimmed). Used to look up options for a property dropdown." }, "groupDisplayName": { "maxLength": 100, "type": "string", "description": "Group display name shown in the UI. Preserves original casing from first creation.", "nullable": true }, "value": { "maxLength": 500, "type": "string", "description": "The selectable option text shown in the dropdown." }, "sortOrder": { "type": "integer", "description": "Sort order within the group (ascending).", "format": "int32" }, "isActive": { "type": "boolean", "description": "When false, the option is hidden from end-user dropdowns but kept in the admin UI." }, "allowAddingNewValuesInline": { "type": "boolean", "description": "When true, end users may add new values to this group from the property editor (with confirmation).\r\nPropagated across all options in the group." }, "createdDate": { "type": "string", "description": "UTC timestamp of when this option was created.", "format": "date-time" } }, "additionalProperties": false, "description": "A single value belonging to a centrally managed dropdown option group." }, "OmniumPropertyOptionOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyOption" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPropertyOptionSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items per page. Defaults to 50 when zero. Max 1000.", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch (1-based). Defaults to 1 when zero.", "format": "int32" }, "group": { "type": "string", "description": "Group key (case-insensitive). When set, only options in this group are returned.", "nullable": true }, "query": { "type": "string", "description": "Free text prefix match against the option value (case-insensitive).", "nullable": true }, "ids": { "type": "array", "items": { "type": "string" }, "description": "Filter to a specific set of option ids.", "nullable": true }, "createdFrom": { "type": "string", "description": "Only return options created at or after this UTC timestamp.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Only return options created at or before this UTC timestamp.", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "Filter by active state. Leave null to include both active and inactive options.", "nullable": true } }, "additionalProperties": false, "description": "Search request for property options." }, "OmniumPunchOutSettings": { "type": "object", "properties": { "unitConversionLists": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumUnitConversionList" }, "nullable": true } }, "additionalProperties": false }, "OmniumPurchaseOrder": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the purchase order", "nullable": true }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number", "nullable": true }, "name": { "type": "string", "description": "Purchase order name", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Warehouse code of the supplier. If set, this purchase order is regarded as an internal transfer, and selected supplier warehouse will be reduced in inventory upon creation of delivery.", "nullable": true }, "supplierId": { "type": "string", "description": "ID of the supplier", "nullable": true }, "supplierPhone": { "type": "string", "description": "Phone number of the supplier", "nullable": true }, "supplierEmail": { "type": "string", "description": "Email address of the supplier", "nullable": true }, "billingCurrency": { "type": "string", "description": "Billing currency for the purchase order", "nullable": true }, "supplierName": { "type": "string", "description": "Name of the supplier", "nullable": true }, "costPriceListId": { "type": "string", "description": "Selected cost price list for this purchase order.\r\nWhen set, products added will use prices from this list (with fallback to regular cost prices).", "nullable": true }, "costPriceListName": { "type": "string", "description": "Display name of the selected cost price list.", "nullable": true }, "marketId": { "type": "string", "description": "Market ID", "nullable": true }, "purchaseOrderForm": { "$ref": "#/components/schemas/OmniumPurchaseOrderForm" }, "purchaseOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of purchase order comments", "nullable": true }, "publicPurchaseOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of public purchase order comments", "nullable": true }, "referenceNumber": { "type": "string", "description": "Reference number of the purchase order", "nullable": true }, "status": { "type": "string", "description": "Status of the purchase order", "nullable": true }, "subTotal": { "type": "number", "description": "Subtotal of the purchase order", "format": "decimal" }, "subTotalExclTax": { "type": "number", "description": "Subtotal excluding tax of the purchase order", "format": "decimal" }, "taxTotal": { "type": "number", "description": "Tax total of the purchase order", "format": "decimal" }, "total": { "type": "number", "description": "Total amount of the purchase order", "format": "decimal" }, "totalExclTax": { "type": "number", "description": "Total amount excluding tax of the purchase order", "format": "decimal" }, "purchaserId": { "type": "string", "description": "ID of the purchaser", "nullable": true }, "purchaserName": { "type": "string", "description": "Name of the purchaser", "nullable": true }, "modified": { "type": "string", "description": "Last modified date and time of the purchase order", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "Creation date and time of the purchase order", "format": "date-time", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties associated with the purchase order", "nullable": true }, "storeId": { "type": "string", "description": "ID of the store", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Requested delivery date of the purchase order", "format": "date-time", "nullable": true }, "origin": { "type": "string", "description": "Origin of the purchase order", "nullable": true }, "versionId": { "type": "string", "description": "Version ID of the purchase order", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the current purchase order.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external IDs. External IDs are visible in Omnium's UI and useful for display, searching and filtering on IDs originating from other systems.\r\nA typical use case could be to add the IDs from ERP/POS/E-COM systems that does not match the purchase order ID in order to simplify integration and traceability", "nullable": true }, "isDelivery": { "type": "boolean", "description": "If true, a delivery is created. All changes on the purchase order is reflected on the delivery." }, "deliveryId": { "type": "string", "description": "If set, all the changes to the line items are reflected in this delivery", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Purchase order tags (Used by notification filters, and for grouping / filtering purchase orders)", "nullable": true }, "projectIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of project IDs linked to this purchase order", "nullable": true } }, "additionalProperties": false, "description": "Purchase orders from suppliers" }, "OmniumPurchaseOrderActionExecutionResult": { "type": "object", "properties": { "actionStatus": { "type": "string", "description": "\"Success\", \"Warning or \"Error\".", "nullable": true }, "errorReason": { "type": "string", "description": "Error description", "nullable": true }, "translateKey": { "type": "string", "description": "Translation key for result description", "nullable": true }, "actionType": { "type": "string", "description": "Order action type (e.g. \"Notification\", \"CapturePayment\", \"ReduceInventory\", etc)", "nullable": true }, "cancelWorkflow": { "type": "boolean", "description": "Is this step cancelling further workflow execution" }, "isInvisible": { "type": "boolean", "description": "True if workflow step and result should be hidden for end user" } }, "additionalProperties": false, "description": "Result from single workflow action" }, "OmniumPurchaseOrderExportModel": { "type": "object", "properties": { "purchaseOrder": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "additionalProperties": false, "description": "Used for webhooks and export" }, "OmniumPurchaseOrderExtendedModel": { "type": "object", "properties": { "purchaseOrder": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "supplier": { "$ref": "#/components/schemas/OmniumSupplier" }, "store": { "$ref": "#/components/schemas/OmniumStore" }, "purchaseOrderLines": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLineExtendedModel" }, "description": "Extended purchase order lines", "nullable": true } }, "additionalProperties": false, "description": "Extended purchase order model with store and supplier information" }, "OmniumPurchaseOrderForm": { "type": "object", "properties": { "lineItems": { "maxLength": 2500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLine" }, "description": "Order lines", "nullable": true }, "total": { "type": "number", "description": "Order total", "format": "decimal" }, "totalExclTax": { "type": "number", "description": "Order total ex tax", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true } }, "additionalProperties": false, "description": "Purchase order form" }, "OmniumPurchaseOrderFormPatch": { "type": "object", "properties": { "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderLinePatch" }, "description": "All order lines", "nullable": true }, "total": { "type": "number", "description": "Order total", "format": "decimal", "nullable": true }, "totalExclTax": { "type": "number", "description": "Order total ex tax", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Purchase order form, containing line items for order" }, "OmniumPurchaseOrderLine": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Unique order line ID. Should be unique across all purchase orders.", "nullable": true }, "splitFromLineItemId": { "type": "string", "description": "LineItemId of the original line this line was split from. Set automatically when a line is split; always references the original (root) line, even across multiple successive splits.", "nullable": true }, "code": { "type": "string", "description": "Sku ID of the order line", "nullable": true }, "displayName": { "type": "string", "description": "Display name of the line item", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name of the line item", "nullable": true }, "ean": { "type": "string", "description": "EAN (European Article Number) / GTIN (Global Trade Item Number) of the line item.", "nullable": true, "deprecated": true }, "gtin": { "type": "string", "description": "GTIN (Global Trade Item Number) of the line item.", "nullable": true }, "imageUrl": { "type": "string", "description": "URL of the image associated with the line item", "nullable": true }, "size": { "type": "string", "description": "Size of the line item", "nullable": true }, "color": { "type": "string", "description": "Color of the line item", "nullable": true }, "brand": { "type": "string", "description": "Brand of the line item", "nullable": true }, "placedPrice": { "type": "number", "description": "Price for one item that this line item represents. This property does not take any discounts into consideration.", "format": "decimal" }, "placedPriceExclTax": { "type": "number", "description": "Price for one item excluding tax. This property does not take any discounts into consideration.", "format": "decimal" }, "currency": { "type": "string", "description": "Currency of the line item price", "nullable": true }, "priceListId": { "type": "string", "description": "ID of the price list / campaign the line's cost price was taken from, if any.", "nullable": true }, "priceListItemId": { "type": "string", "description": "ID of the specific price list item the line's cost price was taken from, if any.", "nullable": true }, "priceListName": { "type": "string", "description": "Name of the price list / campaign the line's cost price was taken from, for display.", "nullable": true }, "quantity": { "type": "number", "description": "Number of items", "format": "decimal" }, "lineItemDiscountAmount": { "type": "number", "description": "Total discount amount applied to the line item", "format": "decimal" }, "lineItemDiscountAmountExclTax": { "type": "number", "description": "Total discount amount applied to the line item, excluding tax", "format": "decimal" }, "extendedPrice": { "type": "number", "description": "Calculated - Total price of the line item, including all discounts applied on the line item (entry level and order level discounts).", "format": "decimal" }, "extendedPriceExclTax": { "type": "number", "description": "Calculated - Total price of the line item, excluding tax, including all discounts applied on the line item (entry level and order level discounts).", "format": "decimal" }, "discountedPrice": { "type": "number", "description": "Calculated - Total price of the line item with all entry level discounts applied on the line item. This does not take order level discounts into account.", "format": "decimal" }, "discountedPriceExclTax": { "type": "number", "description": "Calculated - Total price of the line item, excluding tax, with all entry level discounts applied on the line item. This does not take order level discounts into account.", "format": "decimal" }, "taxTotal": { "type": "number", "description": "Calculated - Tax total for the line item, calculated from the tax group on the product", "format": "decimal" }, "taxRate": { "type": "number", "description": "Tax rate applied to the line item. For example, if the tax rate is 25%, the value here should be 25.00.", "format": "decimal" }, "unit": { "type": "string", "description": "Unit of measurement for the line item", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the line item", "nullable": true }, "updateStock": { "type": "boolean", "description": "Specifies whether to update the stock for the line item" }, "deliveredQuantity": { "type": "number", "description": "Quantity of the line item that has been delivered", "format": "decimal" }, "canceledQuantity": { "type": "number", "description": "Quantity of the line item that has been canceled", "format": "decimal" }, "countedQuantity": { "type": "number", "description": "Quantity of the line item that has been counted", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of custom properties associated with the line item", "nullable": true }, "comment": { "type": "string", "description": "Comment for the line item", "nullable": true }, "supplierSkuId": { "type": "string", "description": "ID of the supplier SKU", "nullable": true }, "supplierName": { "type": "string", "description": "Name of the supplier", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "ID of the purchase order associated with the line item", "nullable": true }, "deliveryId": { "type": "string", "description": "ID of the delivery associated with the line item", "nullable": true }, "estimatedTimeOfArrival": { "type": "string", "description": "Estimated time of arrival for the line item", "format": "date-time", "nullable": true }, "isPackage": { "type": "boolean", "description": "Specifies whether the line item is a package" }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Used for specification of package products", "nullable": true }, "packageName": { "type": "string", "description": "Name of the package", "nullable": true }, "packageSkuId": { "type": "string", "description": "SKU ID of the package", "nullable": true }, "packageLineItemId": { "type": "string", "description": "Line item ID of the package", "nullable": true }, "isConfigurableProduct": { "type": "boolean", "description": "Indicates whether the order line represents a configurable product. This value is set when a configurable product is created from the cart. Configurable products exist only as order lines and do not have standalone product entries" }, "warehouseCode": { "type": "string", "description": "Warehouse code for the line item", "nullable": true }, "isDisabledForAllocation": { "type": "boolean", "description": "Specifies whether the line item is disabled for allocation" }, "volume": { "type": "number", "description": "Total volume per unit of the line item, in cubic decimeters (dm³).", "format": "double", "nullable": true }, "updateCostPrice": { "type": "boolean", "description": "Specifies whether to update the cost price on the product from this line item when goods reception is processed." }, "location": { "type": "string", "description": "Inventory location", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity (D-Pack)", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "allocateBasedOnRules": { "type": "boolean", "description": "Only for Virtual Stock Locations - When true the line item inventory will be allocated to the virtual stock locations based on relevant inventory rules." }, "virtualWarehouseAllocations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumVirtualWarehouseAllocation" }, "description": "Only for Virtual Stock Locations - When purchase order is created for warehouse with VSLs then this VirtualWarehouseAllocations can be used to specify how the goods are divided between VSLs", "nullable": true }, "selectedUnit": { "type": "string", "description": "The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)", "nullable": true }, "selectedUnitConversionFactor": { "type": "number", "description": "Conversion factor from default unit to selected unit", "format": "decimal", "nullable": true }, "selectedUnitQuantity": { "type": "number", "description": "The quantity ordered in the selected unit of measurement.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Purchase order line" }, "OmniumPurchaseOrderLineExtendedModel": { "type": "object", "properties": { "purchaseOrderLine": { "$ref": "#/components/schemas/OmniumPurchaseOrderLine" }, "customerOrderNumber": { "type": "string", "description": "Order number reference for end customer", "nullable": true } }, "additionalProperties": false, "description": "Extended purchase order line with end customer information" }, "OmniumPurchaseOrderLinePatch": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Unique order line ID", "nullable": true }, "code": { "type": "string", "description": "Sku ID of the order line", "nullable": true }, "displayName": { "type": "string", "description": "Display name of the line item", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name of the line item", "nullable": true }, "ean": { "type": "string", "description": "EAN (European Article Number) / GTIN (Global Trade Item Number) of the line item.", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTINs (Global Trade Item Number) of the line item.", "nullable": true, "deprecated": true }, "gtin": { "type": "string", "description": "GTIN (Global Trade Item Number) of the line item.", "nullable": true }, "imageUrl": { "type": "string", "description": "URL of the image associated with the line item", "nullable": true }, "size": { "type": "string", "description": "Size of the line item", "nullable": true }, "color": { "type": "string", "description": "Color of the line item", "nullable": true }, "brand": { "type": "string", "description": "Brand of the line item", "nullable": true }, "placedPriceExclTax": { "type": "number", "description": "Price for one item excluding tax. This property does not take any discounts into consideration.", "format": "decimal", "nullable": true }, "placedPrice": { "type": "number", "description": "Price for one item that this line item represents. This property does not take any discounts into consideration.", "format": "decimal", "nullable": true }, "currency": { "type": "string", "description": "Currency of the line item price", "nullable": true }, "quantity": { "type": "number", "description": "Number of items", "format": "decimal", "nullable": true }, "lineItemDiscountAmount": { "type": "number", "description": "Total discount amount applied to the line item", "format": "decimal", "nullable": true }, "lineItemDiscountAmountExclTax": { "type": "number", "description": "Total discount amount applied to the line item, excluding tax", "format": "decimal", "nullable": true }, "taxTotal": { "type": "number", "description": "Tax total for the line item, calculated from the tax group on the product", "format": "decimal", "nullable": true }, "taxRate": { "type": "number", "description": "Tax rate applied to the line item. For example, if the tax rate is 25%, the value here should be 25.00.", "format": "decimal", "nullable": true }, "unit": { "type": "string", "description": "Unit of measurement for the line item", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the line item", "nullable": true }, "updateStock": { "type": "boolean", "description": "Specifies whether to update the stock for the line item", "nullable": true }, "deliveredQuantity": { "type": "number", "description": "Quantity of the line item that has been delivered", "format": "decimal", "nullable": true }, "canceledQuantity": { "type": "number", "description": "Quantity of the line item that has been canceled", "format": "decimal", "nullable": true }, "countedQuantity": { "type": "number", "description": "Quantity of the line item that has been counted", "format": "decimal", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of custom properties associated with the line item", "nullable": true }, "comment": { "type": "string", "description": "Comment for the line item", "nullable": true }, "supplierSkuId": { "type": "string", "description": "ID of the supplier SKU", "nullable": true }, "supplierName": { "type": "string", "description": "Name of the supplier", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "ID of the purchase order associated with the line item", "nullable": true }, "deliveryId": { "type": "string", "description": "ID of the delivery associated with the line item", "nullable": true }, "estimatedTimeOfArrival": { "type": "string", "description": "Estimated time of arrival for the line item", "format": "date-time", "nullable": true }, "isPackage": { "type": "boolean", "description": "Specifies whether the line item is a package", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Used for specification of package products", "nullable": true }, "packageName": { "type": "string", "description": "Name of the package", "nullable": true }, "packageSkuId": { "type": "string", "description": "SKU ID of the package", "nullable": true }, "packageLineItemId": { "type": "string", "description": "Line item ID of the package", "nullable": true }, "isConfigurableProduct": { "type": "boolean", "description": "Indicates whether the order line represents a configurable product. This value is set when a configurable product is created from the cart. Configurable products exist only as order lines and do not have standalone product entries" }, "warehouseCode": { "type": "string", "description": "Warehouse code for the line item", "nullable": true }, "isDisabledForAllocation": { "type": "boolean", "description": "Specifies whether the line item is disabled for allocation", "nullable": true }, "volume": { "type": "number", "description": "Total volume per unit of the line item, in cubic decimeters (dm³).", "format": "double", "nullable": true }, "updateCostPrice": { "type": "boolean", "description": "Specifies whether to update the cost price on the product from this line item when goods reception is processed.", "nullable": true }, "location": { "type": "string", "description": "Inventory location", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity (D-Pack)", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "allocateBasedOnRules": { "type": "boolean", "description": "Only for Virtual Stock Locations - When true the line item inventory will be allocated to the virtual stock locations based on relevant inventory rules.", "nullable": true }, "virtualWarehouseAllocations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumVirtualWarehouseAllocation" }, "description": "Only for Virtual Stock Locations - When purchase order is created for warehouse with VSLs then this VirtualWarehouseAllocations can be used to specify how the goods are divided between VSLs", "nullable": true }, "selectedUnit": { "type": "string", "description": "The selected unit of measurement on order line if product is sold in multiple units (Null if sold unit is default unit)", "nullable": true }, "selectedUnitConversionFactor": { "type": "number", "description": "Conversion factor from default unit to selected unit", "format": "decimal", "nullable": true }, "selectedUnitQuantity": { "type": "number", "description": "The quantity ordered in the selected unit of measurement.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Purchase order line" }, "OmniumPurchaseOrderLineReference": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item ID", "nullable": true }, "quantity": { "type": "number", "description": "Quantity", "format": "decimal" }, "code": { "type": "string", "description": "Quantity", "nullable": true }, "packageBarcode": { "type": "string", "description": "The Barcode of the kolli/package that contains this lineItem. Can be the same over multiple lineitems", "nullable": true } }, "additionalProperties": false, "description": "Representing a line item for creating new delivery from purchase orders" }, "OmniumPurchaseOrderOmniumQueryResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of items matching the query (not just this page)", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "The items in this page/batch", "nullable": true }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet/aggregation results. Only populated when facets are specified in the request.", "nullable": true } }, "additionalProperties": false, "description": "Generic result from a paginated Query endpoint. Contains plain entity objects.\r\nWorks with any entity type: OmniumProduct, OmniumOrder, OmniumCustomer, OmniumCart, etc.\r\nFor scroll-capable endpoints, see Omnium.Public.Search.Query.OmniumScrollableQueryResult`1." }, "OmniumPurchaseOrderOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumPurchaseOrderOmniumScrollableQueryResult": { "type": "object", "properties": { "scrollId": { "type": "string", "description": "Scroll continuation token. Pass this to the scroll continuation endpoint to fetch the next batch.\r\nNull when there are no more results.", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of items matching the query (not just this page)", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "The items in this page/batch", "nullable": true }, "facets": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Facet/aggregation results. Only populated when facets are specified in the request.", "nullable": true } }, "additionalProperties": false, "description": "Result from a scroll-capable Query endpoint. Adds a scroll continuation token\r\nto the standard Omnium.Public.Search.Query.OmniumQueryResult`1." }, "OmniumPurchaseOrderOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrder" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumPurchaseOrderPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the purchase order", "nullable": true }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number", "nullable": true }, "name": { "type": "string", "description": "Purchase order name", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Warehouse code of the supplier. If set, this purchase order is regarded as an internal transfer, and selected supplier warehouse will be reduced in inventory upon creation of delivery.", "nullable": true }, "supplierId": { "type": "string", "description": "ID of the supplier", "nullable": true }, "supplierPhone": { "type": "string", "description": "Phone number of the supplier", "nullable": true }, "supplierEmail": { "type": "string", "description": "Email address of the supplier", "nullable": true }, "billingCurrency": { "type": "string", "description": "Billing currency for the purchase order", "nullable": true }, "supplierName": { "type": "string", "description": "Name of the supplier", "nullable": true }, "costPriceListId": { "type": "string", "description": "Selected cost price list for this purchase order.\r\nWhen set, products added will use prices from this list (with fallback to regular cost prices).", "nullable": true }, "costPriceListName": { "type": "string", "description": "Display name of the selected cost price list.", "nullable": true }, "marketId": { "type": "string", "description": "Market ID", "nullable": true }, "purchaseOrderForm": { "$ref": "#/components/schemas/OmniumPurchaseOrderFormPatch" }, "purchaseOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of purchase order comments", "nullable": true }, "publicPurchaseOrderNotes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumComment" }, "description": "List of public purchase order comments", "nullable": true }, "referenceNumber": { "type": "string", "description": "Reference number of the purchase order", "nullable": true }, "status": { "type": "string", "description": "Status of the purchase order", "nullable": true }, "purchaserId": { "type": "string", "description": "ID of the purchaser", "nullable": true }, "purchaserName": { "type": "string", "description": "Name of the purchaser", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties associated with the purchase order", "nullable": true }, "storeId": { "type": "string", "description": "ID of the store", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "Requested delivery date of the purchase order", "format": "date-time", "nullable": true }, "origin": { "type": "string", "description": "Origin of the purchase order", "nullable": true }, "keepExistingListItems": { "type": "boolean", "description": "Determines behaviour when updating list where items does not have unique id (Properties). If true, new items will be added to the existing list.\r\nIf false, the existing list will be replaced with the new list. 'True' by default.", "nullable": true }, "keepExistingOrderLines": { "type": "boolean", "description": "Determines behaviour when updating order lines. If true, new items will be added to the existing list.\r\nIf false, the existing list will be replaced with the new list. 'True' by default.", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the current purchase order", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external IDs. External IDs are visible in Omnium's UI and useful for display, searching and filtering on IDs originating from other systems.\r\nA typical use case could be to add the IDs from ERP/POS/E-COM systems that does not match the purchase order ID in order to simplify integration and traceability", "nullable": true }, "isDelivery": { "type": "boolean", "description": "If true, a delivery is created. All changes on the purchase order is reflected on the delivery.", "nullable": true }, "deliveryId": { "type": "string", "description": "If set, all the changes to the line items are reflected in this delivery", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Purchase order tags (Used by notification filters, and for grouping / filtering purchase orders)", "nullable": true }, "projectIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of project IDs linked to this purchase order", "nullable": true } }, "additionalProperties": false, "description": "Omnium order patch object" }, "OmniumPurchaseOrderQueryRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items per page. Default applied when null: 10. Allowed range: 1–1000.", "format": "int32", "nullable": true }, "page": { "type": "integer", "description": "Page number (1-indexed). Default applied when null: 1. Max offset (Take * Page) is 10,000.\r\nFor larger datasets — bulk exports, system syncs — use the scroll endpoint instead.", "format": "int32", "nullable": true }, "searchText": { "type": "string", "description": "Free-text search across purchase order fields (order number, supplier, reference number, etc.).\r\nAlso matches the purchase order document ID exactly. Max 300 characters.", "nullable": true }, "purchaseOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by purchase order document IDs (exact match).", "nullable": true }, "orderNumber": { "type": "string", "description": "Filter by purchase order number.", "nullable": true }, "statuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by purchase order statuses.", "nullable": true }, "storeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs.", "nullable": true }, "supplierId": { "type": "string", "description": "Filter by supplier ID.", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Filter by supplier warehouse code (warehouse used for sending internal transfers).", "nullable": true }, "email": { "type": "string", "description": "Filter by supplier email address.", "nullable": true }, "orderType": { "type": "string", "description": "Filter by purchase order type (InternalTransfer or PurchaseOrder).", "nullable": true }, "skuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by SKU IDs on the order lines. Returns purchase orders containing at least one\r\norder line with a matching SKU.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by external IDs.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags. Returns purchase orders carrying at least one of the tags.", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude purchase orders carrying any of these tags.", "nullable": true }, "deliveryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by delivery IDs assigned to the order lines.", "nullable": true }, "projectId": { "type": "string", "description": "Filter by project ID.", "nullable": true }, "errorKeys": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by entity error keys. Returns purchase orders that have at least one error with a\r\nmatching key.", "nullable": true }, "hasDelivery": { "type": "boolean", "description": "Filter by whether the purchase order has at least one order line with a delivery assigned.\r\nTrue returns only purchase orders with a delivery on one or more lines; false returns only\r\npurchase orders with no deliveries on any line; null (default) returns both.", "nullable": true }, "createdFrom": { "type": "string", "description": "Minimum creation date.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Maximum creation date.", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Minimum modified date. Use with Omnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderQueryRequestBase.ModifiedTo for delta queries.", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Maximum modified date.", "format": "date-time", "nullable": true }, "requestedDeliveryDateFrom": { "type": "string", "description": "Minimum requested delivery date.", "format": "date-time", "nullable": true }, "requestedDeliveryDateTo": { "type": "string", "description": "Maximum requested delivery date.", "format": "date-time", "nullable": true }, "fields": { "$ref": "#/components/schemas/OmniumFieldSelection" }, "sort": { "maxLength": 10, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSortField" }, "description": "Sort fields in priority order. Each entry specifies a field name and direction (\"asc\" or \"desc\").\r\nAvailable field names are entity-specific (e.g. \"price\", \"name\", \"modified\" for products).", "nullable": true } }, "additionalProperties": false, "description": "Request model for the paginated purchase order Query endpoint (POST /api/PurchaseOrders/Query).\r\nInherits all purchase order filter fields from Omnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderQueryRequestBase;\r\nadds pagination controls.\r\n \r\nFor bulk extraction (full syncs, exports), use\r\nOmnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderScrollQueryRequest with the scroll endpoint instead." }, "OmniumPurchaseOrderScrollQueryRequest": { "type": "object", "properties": { "scrollSize": { "type": "integer", "description": "Number of items per scroll batch. Default applied when null: 500. Allowed range: 100–1000.", "format": "int32", "nullable": true }, "searchText": { "type": "string", "description": "Free-text search across purchase order fields (order number, supplier, reference number, etc.).\r\nAlso matches the purchase order document ID exactly. Max 300 characters.", "nullable": true }, "purchaseOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by purchase order document IDs (exact match).", "nullable": true }, "orderNumber": { "type": "string", "description": "Filter by purchase order number.", "nullable": true }, "statuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by purchase order statuses.", "nullable": true }, "storeIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs.", "nullable": true }, "supplierId": { "type": "string", "description": "Filter by supplier ID.", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Filter by supplier warehouse code (warehouse used for sending internal transfers).", "nullable": true }, "email": { "type": "string", "description": "Filter by supplier email address.", "nullable": true }, "orderType": { "type": "string", "description": "Filter by purchase order type (InternalTransfer or PurchaseOrder).", "nullable": true }, "skuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by SKU IDs on the order lines. Returns purchase orders containing at least one\r\norder line with a matching SKU.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by external IDs.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags. Returns purchase orders carrying at least one of the tags.", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Exclude purchase orders carrying any of these tags.", "nullable": true }, "deliveryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by delivery IDs assigned to the order lines.", "nullable": true }, "projectId": { "type": "string", "description": "Filter by project ID.", "nullable": true }, "errorKeys": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by entity error keys. Returns purchase orders that have at least one error with a\r\nmatching key.", "nullable": true }, "hasDelivery": { "type": "boolean", "description": "Filter by whether the purchase order has at least one order line with a delivery assigned.\r\nTrue returns only purchase orders with a delivery on one or more lines; false returns only\r\npurchase orders with no deliveries on any line; null (default) returns both.", "nullable": true }, "createdFrom": { "type": "string", "description": "Minimum creation date.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Maximum creation date.", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Minimum modified date. Use with Omnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderQueryRequestBase.ModifiedTo for delta queries.", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Maximum modified date.", "format": "date-time", "nullable": true }, "requestedDeliveryDateFrom": { "type": "string", "description": "Minimum requested delivery date.", "format": "date-time", "nullable": true }, "requestedDeliveryDateTo": { "type": "string", "description": "Maximum requested delivery date.", "format": "date-time", "nullable": true }, "fields": { "$ref": "#/components/schemas/OmniumFieldSelection" }, "sort": { "maxLength": 10, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSortField" }, "description": "Sort fields in priority order. Each entry specifies a field name and direction (\"asc\" or \"desc\").\r\nAvailable field names are entity-specific (e.g. \"price\", \"name\", \"modified\" for products).", "nullable": true } }, "additionalProperties": false, "description": "Request model for the scroll purchase order Query endpoint (POST /api/PurchaseOrders/Query/Scroll).\r\nInherits all purchase order filter fields from Omnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderQueryRequestBase;\r\nadds scroll batch sizing.\r\n \r\nUse this for bulk extraction — full syncs to other systems (ERP, BI), data exports. For\r\nUI-style paginated queries, use Omnium.Public.PurchaseOrders.Query.OmniumPurchaseOrderQueryRequest with the regular\r\nQuery endpoint instead." }, "OmniumPurchaseOrderSearchRequest": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number to search for.", "nullable": true }, "email": { "type": "string", "description": "Email address to search for.", "nullable": true }, "phone": { "type": "string", "description": "Phone number to search for.", "nullable": true }, "searchText": { "type": "string", "description": "Text to search for.", "nullable": true }, "selectedStatuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected statuses to filter the search results.", "nullable": true }, "supplierName": { "type": "string", "description": "Supplier name to search for.", "nullable": true }, "supplierId": { "type": "string", "description": "Supplier ID to search for.", "nullable": true }, "supplierWarehouseCode": { "type": "string", "description": "Supplier warehouse code (warehouse used for sending internal transfers)", "nullable": true }, "orderType": { "type": "string", "description": "Purchase order type (InternalTransfer or PurchaseOrder)", "nullable": true }, "createdFrom": { "type": "string", "description": "Minimum creation date to filter the search results.", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Maximum creation date to filter the search results.", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Minimum modified date to filter the search results.", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Maximum modified date to filter the search results.", "format": "date-time", "nullable": true }, "requestedDeliveryDateFrom": { "type": "string", "description": "Minimum requested delivery date to filter the search results.", "format": "date-time", "nullable": true }, "requestedDeliveryDateTo": { "type": "string", "description": "Maximum requested delivery date to filter the search results.", "format": "date-time", "nullable": true }, "urgent": { "type": "boolean", "description": "Indicates whether the search should include urgent orders only." }, "selectedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected store names to filter the search results.", "nullable": true }, "take": { "type": "integer", "description": "Number of records to retrieve per page.", "format": "int32" }, "page": { "type": "integer", "description": "Page number of the search results.", "format": "int32" }, "productNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of product numbers to filter the search results.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search purchase orders with external IDs", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort order of the search results.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by tags", "nullable": true }, "excludedTags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Filter by excluding tags", "nullable": true }, "hasDelivery": { "type": "boolean", "description": "Filter by whether the purchase order has at least one order line with a delivery assigned.\r\nTrue returns only purchase orders with a delivery on one or more lines; false returns only purchase orders with no deliveries on any line; null (default) returns both.", "nullable": true } }, "additionalProperties": false, "description": "Search model for purchase orders" }, "OmniumPurchaseOrderWorkflowExecutionResult": { "type": "object", "properties": { "purchaseOrderActionExecutionResults": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPurchaseOrderActionExecutionResult" }, "description": "List of action results", "nullable": true }, "isAborted": { "type": "boolean", "description": "True if workflow failed and is aborted" }, "purchaseOrder": { "$ref": "#/components/schemas/OmniumPurchaseOrder" } }, "additionalProperties": false, "description": "Purchase order workflow execution result" }, "OmniumPurchaseOrderWorkflowRequest": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "expectedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Purchase order workflow execution request" }, "OmniumRating": { "type": "object", "properties": { "id": { "type": "string", "description": "Rating ID", "nullable": true }, "parentId": { "type": "string", "description": "Parent rating ID", "nullable": true }, "date": { "type": "string", "description": "Rated date", "format": "date-time" }, "value": { "type": "integer", "description": "Rating score", "format": "int32" }, "type": { "type": "string", "description": "Rating type (E.g. Customer, Product, etc)", "nullable": true }, "objectId": { "type": "string", "description": "ID of the object being evaluated (Partner ID, Product ID, etc)", "nullable": true }, "parentObjectId": { "type": "string", "description": "Parent ID\r\nFor product ratings this will be product.ParentId and can be used to set rating count and average for all products\r\nsharing the same parentId.", "nullable": true }, "skuId": { "type": "string", "description": "SkuId of the object being evaluated (if product rating)", "nullable": true }, "objectName": { "type": "string", "description": "Name of the object being evaluated (Product name, project name etc)", "nullable": true }, "raterName": { "type": "string", "description": "Name of the rater", "nullable": true }, "raterDisplayName": { "type": "string", "description": "Name of the rater. To be used on website. Can be only first name if DisplayOnlyFirstName is true. Else it will be same as RaterName", "nullable": true }, "displayOnlyFirstName": { "type": "boolean", "description": "Display only firstname. To be used on website if user wants to be anonymous" }, "raterId": { "type": "string", "description": "Rater ID (typical customer ID)", "nullable": true }, "comment": { "type": "string", "description": "Rating comment", "nullable": true }, "storeId": { "type": "string", "description": "Store ID", "nullable": true }, "marketId": { "type": "string", "description": "Market ID", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for any other rating info", "nullable": true }, "imageUrl": { "type": "string", "description": "Product image", "nullable": true }, "attentionRequired": { "type": "boolean", "description": "Requires attention by customer service", "nullable": true }, "ratingReply": { "$ref": "#/components/schemas/OmniumRatingReply" } }, "additionalProperties": false, "description": "Class for rating other entities, like products, customers, stores, etc" }, "OmniumRatingOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRating" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumRatingOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRating" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumRatingReply": { "type": "object", "properties": { "comment": { "type": "string", "description": "Comment/answere to a rating/review", "nullable": true }, "created": { "type": "string", "description": "Reply date", "format": "date-time" }, "replyAuthorId": { "type": "string", "description": "Author of the reply", "nullable": true }, "replyAuthorDisplayName": { "type": "string", "description": "Public diplayed author of reply. Could be \"Customer service\" etc.", "nullable": true } }, "additionalProperties": false, "description": "Class for creating a comment/answer to a rating/review" }, "OmniumRecommendationsResult": { "type": "object", "properties": { "recommendations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductListItemViewModelRecommendation" }, "nullable": true } }, "additionalProperties": false }, "OmniumRelatedProduct": { "type": "object", "properties": { "key": { "type": "string", "description": "Key describing relation. E.g. \"Siblings\", \"Accessories\", etc...", "nullable": true }, "translateKey": { "type": "string", "description": "TranslateKey used for translation in UI (but could of course also be used in your application)", "nullable": true }, "relatedProductItems": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProductItem" }, "description": "Products related", "nullable": true } }, "additionalProperties": false, "description": "Representing a collection of related product items by a given key. A key could be \"Siblings\", \"Accessories\", etc" }, "OmniumRelatedProductItem": { "type": "object", "properties": { "productId": { "type": "string", "description": "Product ID", "nullable": true }, "skuId": { "type": "string", "description": "Sku ID", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true } }, "additionalProperties": false, "description": "" }, "OmniumRentalAvailabilityPeriod": { "type": "object", "properties": { "from": { "type": "string", "description": "The start of the period", "format": "date-time" }, "to": { "type": "string", "description": "The end of the period", "format": "date-time", "nullable": true }, "products": { "type": "array", "items": { "type": "string" }, "description": "The products that are available for rental during this period.\r\nAs in the products that are not booked.", "nullable": true } }, "additionalProperties": false, "description": "A time period specifying which products are available for rental" }, "OmniumRentalAvailabilityRequest": { "required": [ "sourceProductSkuId" ], "type": "object", "properties": { "sourceProductSkuId": { "type": "string", "description": "The SKU of the source product of the rental products.\r\nWill search all rental products of this product." }, "rentalProductIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the rental products to fetch availability.\r\nLeave blank for all rental products.", "nullable": true }, "from": { "type": "string", "description": "From what date/time to fetch availability.", "format": "date-time", "nullable": true }, "to": { "type": "string", "description": "To what date/time to fetch availability.", "format": "date-time", "nullable": true }, "storeId": { "type": "string", "description": "The store to search for rental products.", "nullable": true } }, "additionalProperties": false, "description": "Request rental availability information on the given rental products" }, "OmniumRentalAvailabilityResult": { "type": "object", "properties": { "sourceProductSkuId": { "type": "string", "description": "SKU ID of the source product for the rental products", "nullable": true }, "rentalProducts": { "type": "array", "items": { "type": "string" }, "description": "Total rental products", "nullable": true }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRentalAvailabilityPeriod" }, "description": "The time periods of availability", "nullable": true }, "bookings": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumRentalBooking" }, "description": "The individual bookings on rental products", "nullable": true } }, "additionalProperties": false, "description": "Availability information" }, "OmniumRentalBooking": { "type": "object", "properties": { "rentalProductId": { "type": "string", "description": "The rental product", "nullable": true }, "projectId": { "type": "string", "description": "The connected project id", "nullable": true }, "projectName": { "type": "string", "description": "The connected project name", "nullable": true }, "customerName": { "type": "string", "description": "Name of the customer the booking is made for", "nullable": true }, "rentalFrom": { "type": "string", "description": "Start of booking period", "format": "date-time" }, "rentalTo": { "type": "string", "description": "End of booking period", "format": "date-time" } }, "additionalProperties": false, "description": "A booking for a rental product" }, "OmniumRentalProductCreateRequest": { "required": [ "count", "sourceProductId", "storeId" ], "type": "object", "properties": { "sourceProductId": { "type": "string", "description": "Product to use for new rental products" }, "storeId": { "type": "string", "description": "A store for which the rental product will be associated" }, "count": { "type": "integer", "description": "How many rental products to create", "format": "int32" }, "warehouseCode": { "type": "string", "description": "If set, will reduce stock of the source product from this warehouse", "nullable": true }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "The prices set on the rental product, can also include deposit prices", "nullable": true } }, "additionalProperties": false, "description": "Request for creation of rental products from existing product" }, "OmniumRentalProductCreateResult": { "type": "object", "properties": { "isSuccessful": { "type": "boolean", "description": "Whether the rental products were successfully created" }, "errorMessage": { "type": "string", "description": "Possible error message", "nullable": true }, "createdProducts": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProduct" }, "description": "The rental products that were created from the request", "nullable": true }, "inventoryReduced": { "type": "integer", "description": "The quantity of stock removed from inventory", "format": "int32" } }, "additionalProperties": false, "description": "Result of rental product creation" }, "OmniumReplacementRequestModel": { "required": [ "orderId", "orderLineReplacements" ], "type": "object", "properties": { "orderId": { "type": "string", "description": "Order id of the exsisting order to replace orderlines from." }, "orderLineReplacements": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineReplacementRequestModel" }, "description": "Request models for orderlines to replace" }, "comment": { "type": "string", "description": "Comment will be added to the replacement payment, and as a property on the replacement order.", "nullable": true }, "amountToCredit": { "type": "number", "description": "Optional: By default, a 'dummy' credit payment will be added to the original order, equal to the value of the replacement. This ensures the customer does not receive both the replacement and a full credit payment.\r\nIn some cases, you may wish to issue a partial credit to the customer, for example, offering a 10% credit due to a delay or any other reason the replacement was necessary. In such scenarios, you should adjust this property's value to reflect the redced amount.\r\n \r\nFor instance, if the total amount for the replacement is 200 and you want to credit the customer 50, you should set this propery's value to 150.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Request model for replacement order" }, "OmniumReplacementSettings": { "type": "object", "properties": { "replacementTypes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumTranslationKeys" }, "nullable": true }, "isMetaDataDeleted": { "type": "boolean" }, "isReplacementOrderUnreplaceable": { "type": "boolean" }, "deletedMetaDataOnOrderLine": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "deletedMetaDataOnOrder": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumReturnCharge": { "type": "object", "properties": { "key": { "type": "string", "description": "Charge type", "nullable": true }, "amount": { "type": "number", "description": "Charge amount", "format": "decimal" } }, "additionalProperties": false, "description": "Return charge" }, "OmniumReturnOrderForm": { "type": "object", "properties": { "returnId": { "type": "string", "description": "Return ID", "nullable": true }, "rmaNumber": { "type": "string", "description": "RMA (return merchandise authorization) number", "nullable": true }, "returnComment": { "type": "string", "description": "Return comment, used to describe reason for return", "nullable": true }, "returnType": { "type": "string", "description": "Return type", "nullable": true }, "storeId": { "type": "string", "description": "Store ID or warehouse where the product is returned", "nullable": true }, "userId": { "type": "string", "description": "User ID creating the return", "nullable": true }, "status": { "type": "string", "description": "Return status", "nullable": true }, "claim": { "$ref": "#/components/schemas/OmniumClaim" }, "modified": { "type": "string", "description": "Date modified", "format": "date-time" }, "created": { "type": "string", "description": "Date created", "format": "date-time" }, "creditAmount": { "type": "number", "description": "Amount to credit", "format": "decimal" }, "creditPayment": { "type": "boolean", "description": "True if payment should be credited" }, "replacementOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "References to any replacement orders related to the return", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external return order IDs", "nullable": true }, "sentNotificationIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Notification IDs sent on this order", "nullable": true }, "returnCharges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnCharge" }, "description": "List of charges on the return (Currently only internal use for ChargeNotPickedUpAmount / ChargeShipmentCostAmount)", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the return.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Return tags (used by workflow filters and for grouping / filtering returns)", "nullable": true }, "shipments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipment" }, "description": "All order shipments", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "All order lines / products", "nullable": true }, "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "All discounts", "nullable": true }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "All order payments", "nullable": true }, "shippingDiscountTotal": { "type": "number", "description": "Calculated:Total shipping discounts", "format": "decimal" }, "shippingSubTotal": { "type": "number", "description": "Calculated: Shipping cost without discounts", "format": "decimal" }, "shippingSubTotalExclTax": { "type": "number", "description": "Calculated: shipping cost without discounts excl tax", "format": "decimal" }, "shippingCreditedTotal": { "type": "number", "description": "Calculated: Total shipping cost credited", "format": "decimal" }, "cartName": { "type": "string", "description": "Name of cart / offer, such as \"A special offer for a special customer\".\r\nThis is typically used in scenarios where a customer is presented with an offer (in form of a cart).", "nullable": true }, "cartId": { "type": "string", "description": "Unique ID of cart", "nullable": true }, "purchaseOrderId": { "type": "string", "description": "Purchase order ID (if order was created from a purchase order)", "nullable": true }, "couponCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of CouponCodes added by user", "nullable": true }, "shippingTotal": { "type": "number", "description": "Calculated: Total shipping cost.", "format": "decimal", "readOnly": true }, "handlingTotal": { "type": "number", "description": "Cost of handling", "format": "decimal" }, "orderLevelTax": { "type": "number", "description": "Order level tax amount", "format": "decimal" }, "taxTotal": { "type": "number", "description": "Calculated: Total tax amount (line item level and order level)", "format": "decimal" }, "discountAmount": { "type": "number", "description": "Calculated: Total discount amount", "format": "decimal" }, "subTotal": { "type": "number", "description": "Calculated: Order total without shipment cost", "format": "decimal" }, "subTotalExclTax": { "type": "number", "description": "Calculated: Order total without shipment cost and without tax", "format": "decimal" }, "total": { "type": "number", "description": "Calculated: Order total, including shipment cost, tax, and discounts", "format": "decimal" }, "totalExclTax": { "type": "number", "description": "Calculated: Order total, including shipment cost and discounts, but without tax", "format": "decimal" }, "authorizedPaymentTotal": { "type": "number", "description": "Total amount authorized by payment providers", "format": "decimal" }, "capturedPaymentTotal": { "type": "number", "description": "Total amount captured by payment providers", "format": "decimal" }, "creditPaymentTotal": { "type": "number", "description": "Total amount credited by payment providers", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "charges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCharge" }, "description": "Obsolete: Add order lines instead. A list of additional charges for the order", "nullable": true, "deprecated": true }, "fullRefund": { "type": "boolean", "description": "True if order should be fully refunded" }, "isPriority": { "type": "boolean", "description": "Possible to mark the order with priority", "nullable": true }, "grossRoundoff": { "type": "number", "description": "Set by external systems. Is added to orderform.total.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Return order form" }, "OmniumReturnOrderFormPatch": { "type": "object", "properties": { "returnId": { "type": "string", "description": "Return ID", "nullable": true }, "rmaNumber": { "type": "string", "description": "RMA (return merchandise authorization) number", "nullable": true }, "returnComment": { "type": "string", "description": "Return comment, used to describe reason for return", "nullable": true }, "returnType": { "type": "string", "description": "Return type", "nullable": true }, "storeId": { "type": "string", "description": "Store ID or warehouse where the product is returned", "nullable": true }, "userId": { "type": "string", "description": "User ID creating the return", "nullable": true }, "status": { "type": "string", "description": "Return status", "nullable": true }, "claim": { "$ref": "#/components/schemas/OmniumClaim" }, "modified": { "type": "string", "description": "Date modified", "format": "date-time", "nullable": true }, "created": { "type": "string", "description": "Date created", "format": "date-time", "nullable": true }, "creditAmount": { "type": "number", "description": "Amount to credit", "format": "decimal", "nullable": true }, "creditPayment": { "type": "boolean", "description": "True if payment should be credited", "nullable": true }, "replacementOrderIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "References to any replacement orders related to the return", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external return order IDs", "nullable": true }, "sentNotificationIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Notification IDs sent on this order", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "List of errors on the return.", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Return tags (used by workflow filters and for grouping / filtering returns)", "nullable": true }, "shouldAddMissingLineItems": { "type": "boolean", "description": "If it should add missing items when patching returnOrderLines" }, "replaceLineItemsArray": { "type": "boolean", "description": "Use this if you want to entirely replace the returnItemsArray and not patch existing lines. This will give you more control, but comes at the cost of possibly losing\r\norderlinedata you dont provide. Can not be used with ShouldAddMissingLineItems" }, "shipments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPatch" }, "description": "All order shipments", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "All order lines / products", "nullable": true }, "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "All discounts", "nullable": true }, "discountsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentPatch" }, "description": "All order payments", "nullable": true }, "paymentsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shipmentsMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shippingDiscountTotal": { "type": "number", "description": "Total shipping discounts", "format": "decimal", "nullable": true }, "shippingSubTotal": { "type": "number", "description": "Shipping cost without discounts", "format": "decimal", "nullable": true }, "shippingSubTotalExclTax": { "type": "number", "description": "shipping cost without discounts excl tax", "format": "decimal", "nullable": true }, "cartName": { "type": "string", "description": "Name of cart / offer", "nullable": true }, "cartId": { "type": "string", "description": "ID of original cart", "nullable": true }, "couponCodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of CouponCodes added by user", "nullable": true }, "couponCodesMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "shippingTotal": { "type": "number", "description": "Total shipping cost", "format": "decimal", "nullable": true, "readOnly": true }, "handlingTotal": { "type": "number", "description": "Cost of handling", "format": "decimal", "nullable": true }, "orderLevelTax": { "type": "number", "description": "Order level tax amount", "format": "decimal", "nullable": true }, "taxTotal": { "type": "number", "description": "Total tax amount (line item level and order level)", "format": "decimal", "nullable": true }, "discountAmount": { "type": "number", "description": "Total discount amount", "format": "decimal", "nullable": true }, "subTotal": { "type": "number", "description": "Ordrer total without shipment cost", "format": "decimal", "nullable": true }, "subTotalExclTax": { "type": "number", "description": "Ordrer total without shipment cost and without tax", "format": "decimal", "nullable": true }, "total": { "type": "number", "description": "Order total, including shipment cost, tax, and discounts", "format": "decimal", "nullable": true }, "totalExclTax": { "type": "number", "description": "Order total, including shipment cost and discounts, but without tax", "format": "decimal", "nullable": true }, "authorizedPaymentTotal": { "type": "number", "description": "Total amount authorized by payment providers", "format": "decimal", "nullable": true }, "capturedPaymentTotal": { "type": "number", "description": "Total amount captured by payment providers", "format": "decimal", "nullable": true }, "creditPaymentTotal": { "type": "number", "description": "Total amount credited by payment providers", "format": "decimal", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "charges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumCharge" }, "description": "A list of additional charges for the order", "nullable": true }, "fullRefund": { "type": "boolean", "description": "True if order should be fully refunded", "nullable": true }, "isPriority": { "type": "boolean", "description": "Possible to mark the order with priority", "nullable": true }, "chargeShipmentCostAmount": { "type": "number", "description": "Patch amount for shipment cost charged the customer", "format": "decimal", "nullable": true }, "creditShipmentAmount": { "type": "number", "description": "Patch amount for shipment cost to credit customer", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Return order form" }, "OmniumReturnOrderSearchRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Return order ID", "nullable": true }, "orderNumber": { "type": "string", "description": "Order number", "nullable": true }, "rmaNumber": { "type": "string", "description": "RMA number", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID", "nullable": true }, "projectId": { "type": "string", "description": "Project ID", "nullable": true }, "email": { "type": "string", "description": "Customer e-mail", "nullable": true }, "phone": { "type": "string", "description": "Customer phone", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "searchText": { "type": "string", "description": "Search text", "nullable": true }, "selectedStores": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Selected store IDs", "nullable": true }, "createdFrom": { "type": "string", "description": "Created from", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Created to", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Modified from date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Modified before date", "format": "date-time", "nullable": true }, "take": { "type": "integer", "description": "Take", "format": "int32" }, "page": { "type": "integer", "description": "Page", "format": "int32" } }, "additionalProperties": false, "description": "Search request object for return orders" }, "OmniumReturnOrderViewModel": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number", "nullable": true }, "orderId": { "type": "string", "description": "Order ID return is related to", "nullable": true }, "returnOrderForm": { "$ref": "#/components/schemas/OmniumReturnOrderForm" }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone", "nullable": true }, "returnStoreName": { "type": "string", "description": "Returned to store name", "nullable": true }, "returnStoreId": { "type": "string", "description": "Returned to store ID", "nullable": true }, "orderStoreName": { "type": "string", "description": "Order store name", "nullable": true } }, "additionalProperties": false, "description": "Model for return lists" }, "OmniumReturnOrderViewModelOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnOrderViewModel" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumReturnRequestModel": { "type": "object", "properties": { "returns": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemReturn" }, "description": "Returned orderlines", "nullable": true }, "storeId": { "type": "string", "description": "Store id for the return", "nullable": true }, "userId": { "type": "string", "description": "User handeling the return", "nullable": true }, "projectTypeId": { "type": "string", "description": "If the return has a connection to a project type", "nullable": true }, "comment": { "type": "string", "description": "Return comment", "nullable": true }, "creditPayment": { "type": "boolean", "description": "Should payment be credited" }, "creditAmount": { "type": "number", "description": "Amount already credited on this return.", "format": "decimal", "nullable": true }, "creditShipment": { "type": "boolean", "description": "Should shipment be credited" }, "creditShipmentAmount": { "type": "number", "description": "Amount to credit for shipment. If not specified, the original order's shipping cost will be used.\r\nUse this to credit additional fees like payment fees along with the shipping cost.", "format": "decimal", "nullable": true }, "chargeShipmentCost": { "type": "boolean", "description": "Should user pay for the shipping return cost" }, "chargeShipmentCostAmount": { "type": "number", "description": "Amout for return shipping cost. If ChargeShipmentCost is true and ChargeShipmentCostAmount is 0, the cost will be overriden standard return cost for market.", "format": "decimal" }, "rmaNumber": { "type": "string", "description": "Return rma identifier", "nullable": true }, "handlingTotal": { "type": "number", "description": "Used if there is handling cost/fee", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Properties", "nullable": true }, "status": { "type": "string", "description": "Status for the return", "nullable": true }, "returnType": { "type": "string", "description": "Type of return", "nullable": true }, "omniumExchangeOrderOptions": { "$ref": "#/components/schemas/OmniumExchangeOrderOptions" } }, "additionalProperties": false, "description": "Request model for order/order line returns" }, "OmniumReturnSettings": { "type": "object", "properties": { "returnTypes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumReturnType" }, "nullable": true }, "defaultUpdateStock": { "type": "boolean" } }, "additionalProperties": false }, "OmniumReturnType": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "translationKey": { "type": "string", "nullable": true }, "updateInventory": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OmniumRole": { "type": "object", "properties": { "id": { "type": "string", "description": "User role ID", "nullable": true }, "displayName": { "type": "string", "description": "Display name", "nullable": true }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "IDs from external systems (key value list)", "nullable": true } }, "additionalProperties": false, "description": "The OmniumRole contains data about roles in Omnium" }, "OmniumSalesLimitation": { "type": "object", "properties": { "marketGroupId": { "type": "string", "description": "Market group ID", "nullable": true }, "customerId": { "type": "string", "description": "Customer ID", "nullable": true }, "from": { "type": "string", "description": "Excluded from", "format": "date-time" }, "to": { "type": "string", "description": "Excluded to", "format": "date-time" }, "code": { "type": "string", "description": "Could be SKU / Product Id / Product Group ID / Barcode", "nullable": true }, "salesLimitationType": { "type": "string", "description": "SKU / ProductId / ProductGroupId / Barcode", "nullable": true } }, "additionalProperties": false, "description": "Class for Sales Limitation" }, "OmniumSalesType": { "type": "object", "properties": { "productCount": { "type": "integer", "description": "Number of physical product items sold.", "format": "int32" }, "serviceCount": { "type": "integer", "description": "Number of service items sold.", "format": "int32" }, "giftCardCount": { "type": "integer", "description": "Number of gift cards sold.", "format": "int32" } }, "additionalProperties": false, "description": "Represents sales breakdown by item type (products, services, gift cards).\r\nNote: This is not a standard POS concept and may be specific to certain systems like Sitoo." }, "OmniumSearchRatingRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "The object class to get ratings from (e.g. BusinessCustomer, Product, etc)", "nullable": true }, "objectId": { "type": "string", "description": "The object id to get ratings from (e.g. 12345)", "nullable": true }, "parentObjectId": { "type": "string", "description": "Parent ID\r\nFor product ratings this will be product.ParentId. Search for ratings where products share the same parentId", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of marketids to filter on", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of storeIds to filter on", "nullable": true }, "page": { "type": "integer", "description": "Page number, fallback to 1", "format": "int32" }, "take": { "type": "integer", "description": "Number of elements, fallback to 10", "format": "int32" }, "requiresAttention": { "type": "boolean", "description": "Filter on ratings that requires attention by customer service (no value -> all)", "nullable": true }, "includeOnlyRatingsWithComments": { "type": "boolean", "description": "If true filter on ratings with comments.", "nullable": true } }, "additionalProperties": false, "description": "Search request for ratings" }, "OmniumSearchRecommendationsRequest": { "type": "object", "properties": { "productIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "skuIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "cartId": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "nullable": true }, "boostedProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true }, "excludedProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true }, "includedProperties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true } }, "additionalProperties": false }, "OmniumSearchRequest": { "type": "object", "properties": { "searchQuery": { "type": "string", "description": "Free text search query", "nullable": true }, "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" } }, "additionalProperties": false, "description": "Generic search request" }, "OmniumSeoInfo": { "type": "object", "properties": { "title": { "type": "string", "description": "Page title", "nullable": true }, "uri": { "type": "string", "description": "Page URI", "nullable": true }, "uriSegment": { "type": "string", "description": "Page uri segment", "nullable": true }, "description": { "type": "string", "description": "Meta description", "nullable": true }, "keywords": { "type": "string", "description": "Meta keywords", "nullable": true }, "languageCode": { "type": "string", "description": "Language code", "nullable": true }, "excludeFromFeed": { "type": "boolean", "description": "If true, the product will be excluded from product feed", "nullable": true } }, "additionalProperties": false, "description": "Product info for search engine optimization" }, "OmniumSetDefaultLocationRequest": { "type": "object", "properties": { "skuId": { "type": "string", "description": "Product SKU / Code / Variant / ID", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse Code / ID", "nullable": true }, "locationCode": { "type": "string", "description": "Location code to set as default", "nullable": true } }, "additionalProperties": false, "description": "Request model for setting the default location for a SKU in a warehouse" }, "OmniumShipment": { "type": "object", "properties": { "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "Shipment discounts", "nullable": true }, "shipmentId": { "type": "string", "description": "Unique identification for shipment. Required for all shipments.", "nullable": true }, "shippingMethodId": { "type": "string", "description": "ID of shipping method", "nullable": true }, "shippingMethodName": { "type": "string", "description": "Name of shipping method for this shipment. Should correspond to a shipment type in Omnium.\r\nTypical values would be \"Bring\", \"PickUpInStore\" or whatever provider or type of shipment that is configured.", "nullable": true }, "shippingLabel": { "type": "string", "description": "User friendly name - Automatically populated from ShipmentOptions defined in Omnium as part of the order workflow.", "nullable": true }, "shippingTax": { "type": "number", "description": "Shipment cost tax", "format": "decimal" }, "shipmentTaxRate": { "type": "number", "description": "Shipment tax rate. If tax is 25%, value here should be 25.00. If not set, default tax rate from market will be used.", "format": "decimal", "nullable": true }, "shipmentTrackingNumber": { "type": "string", "description": "Tracking number from external shipping provider", "nullable": true }, "shipmentTrackingLink": { "type": "string", "description": "Tracking link for external shipping provider", "nullable": true }, "shipmentLabelLink": { "type": "string", "description": "Shipping label link", "nullable": true }, "shippingDiscountAmount": { "type": "number", "description": "Calculated - Total discounts for shipping. Calculated from the discount list", "format": "decimal" }, "shippingSubTotal": { "type": "number", "description": "Shipping cost, without discounts", "format": "decimal" }, "shippingTotal": { "type": "number", "description": "Calculated - Total shipping cost (Calculated, shippingSubTotal - shippingDiscountAmount)", "format": "decimal", "readOnly": true }, "shippingSubTotalExclTax": { "type": "number", "description": "Calculated - Shipping cost without discounts excl tax", "format": "decimal" }, "shippingCreditedTotal": { "type": "number", "description": "Total shipping cost credited", "format": "decimal" }, "status": { "type": "string", "description": "Shipment status", "nullable": true }, "orderStatus": { "type": "string", "description": "The shipment order status is used in workflows for partial shipments the same way as the order status is used for orders with single shipments.\r\nThis means the values for the shipments OrderStatus should be the same values as the available order statuses.", "nullable": true }, "prevStatus": { "type": "string", "description": "Previous status. Automatically set by Omnium's workflow", "nullable": true }, "subTotal": { "type": "number", "description": "Calculated - Sum of all lineItems", "format": "decimal" }, "total": { "type": "number", "description": "Calculated - Sum of all lineItems and shipping cost", "format": "decimal" }, "taxTotal": { "type": "number", "description": "LineItems tax total + shippingTax", "format": "decimal" }, "warehouseCode": { "type": "string", "description": "Warehouse shipment is sent from. Should correspond to a store ID in Omnium.", "nullable": true }, "virtualWarehouseCode": { "type": "string", "description": "Only relevant when using Virtual Stock Locations - Specifies which of the virtual Warehouses the inventory should be reduced.", "nullable": true }, "pickUpWarehouseCode": { "type": "string", "description": "Warehouse shipment is sent to (optional) for pickup. Should correspond to a store ID in Omnium.", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLine" }, "description": "Shipment line items / order lines", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "transit": { "type": "boolean", "description": "True if shipment is between two warehouses" }, "comment": { "type": "string", "description": "Shipment comments", "nullable": true }, "returnTrackingNumber": { "type": "string", "description": "Tracking number if return shipment is booked", "nullable": true }, "returnTrackingLink": { "type": "string", "description": "Tracking link if return shipment is booked", "nullable": true }, "returnLabelLink": { "type": "string", "description": "Link to return shipment label", "nullable": true }, "servicePointId": { "type": "string", "description": "Id to third party shipment service/pickup point. If you only have id set this prop. If you have complete info about pickUp point, set PickUpPointInformation object", "nullable": true }, "pickUpPointInformation": { "$ref": "#/components/schemas/OmniumShippingPickUpPoint" }, "expectedDeliveryDate": { "type": "string", "description": "Expected/Requested delivery date for this shipment", "format": "date-time", "nullable": true }, "packages": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPackage" }, "description": "Shipment packages, used by third party shipping providers", "nullable": true }, "expectedShipmentDate": { "type": "string", "description": "Calculated - Expected shipment date (based on ATP)", "format": "date-time", "nullable": true }, "shippingMethodProductId": { "type": "string", "description": "Shipping method product ID.\r\nUsed for external shipping providers that has shipping method product IDs defined.", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external shipment IDs", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/OmniumContactPerson" }, "isAllocated": { "type": "boolean", "description": "Determines if shipment is allocated, set to true if shipment should not be reallocated." }, "goodsDescription": { "type": "string", "description": "Describe shipment content", "nullable": true }, "orderStatusLog": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderStatusLogItem" }, "description": "Timeline of all status changes for this shipment, including timestamps and duration between statuses.", "nullable": true }, "completed": { "type": "string", "description": "Completed date", "format": "date-time", "nullable": true }, "updateStatusDate": { "type": "string", "description": "Date when shipment should be moved to next order status. (Processed by UpdateOrderStatusScheduledTask)", "format": "date-time", "nullable": true }, "nextOrderStatus": { "type": "string", "description": "Shipment order status to transition to at UpdateStatusDate. (Processed by UpdateOrderStatusScheduledTask)", "nullable": true } }, "additionalProperties": false, "description": "Representing a shipment" }, "OmniumShipmentDimensions": { "type": "object", "properties": { "heightInCm": { "type": "integer", "description": "Pacakge height in cm", "format": "int32" }, "widthInCm": { "type": "integer", "description": "Pacakge width in cm", "format": "int32" }, "lengthInCm": { "type": "integer", "description": "Pacakge length in cm", "format": "int32" } }, "additionalProperties": false, "description": "Shipment package dimensions" }, "OmniumShipmentLineItemsUpdateModel": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "Id of shipment to add line items to", "nullable": true }, "lineItemIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Ids of existing line items to add to shipment", "nullable": true } }, "additionalProperties": false, "description": "Shipment line items update model for adding existing line items to a shipment" }, "OmniumShipmentOption": { "type": "object", "properties": { "shippingMethodId": { "type": "string", "description": "Unique id for this option(if ShippingMethodName is not enough", "nullable": true }, "shippingGateway": { "type": "string", "description": "Provider gateway to use, e.g Bring, PostNord.", "nullable": true }, "shippingPriceGateway": { "type": "string", "description": "If shipment prices and valid shipment options should be calculated by provider, but booking should not be done set ShippingPriceGateway to provider name, and set ShippingGateway to \"Empty\"", "nullable": true }, "shippingMethodName": { "type": "string", "description": "Unique name to identify the shipping product. This value should match what the sales channel adds to an order and sends to OMS.", "nullable": true }, "countryCode": { "type": "string", "description": "Two letter countryCode. Providers use this to get pickupPoints", "nullable": true }, "shippingCompany": { "type": "string", "description": "If PickUp Point provider diff from ShippingGateway. GateWay is Logistra, and pickupPoint service is PostNord", "nullable": true }, "shipmentProduct": { "type": "string", "description": "The product to book. E.g \"PICKUP_PARCEL\", \"mypack\". Get this value from provider", "nullable": true }, "shipmentProductName": { "type": "string", "description": "Some providers need both ShipmentProduct and ShipmentProductName. Then ShipmentProduct will be \"12543\" and name \"mypack\"", "nullable": true }, "providerNotification": { "type": "boolean", "description": "If provider should use notifications(Send out sms/emails from Bring/Postnord)" }, "shipmentReturnProduct": { "type": "string", "description": "If return label should be created. Add provider name for return here. \"MYPACK_COLLECT_RETURN\"", "nullable": true }, "shippingSubTotal": { "type": "number", "description": "Set if a default shipping cost is used", "format": "decimal" }, "getPriceFromProvider": { "type": "boolean", "description": "Set if prices should be calculated by provider, based on cart/order and address" }, "addTaxOnProviderPrice": { "type": "boolean", "description": "Should tax be added to provider shipping cost" }, "additionalCustomerPricePercentage": { "type": "number", "description": "Most providers gives you a cost price for the shipment. If needed, add a surcharge here in percentage", "format": "decimal" }, "discountedPrice": { "type": "number", "description": "If there is a discounted price for the shipment", "format": "decimal" }, "discountLabel": { "type": "string", "description": "Discount label", "nullable": true }, "deliveryTime": { "type": "string", "description": "Default delivery time for this option", "nullable": true }, "logoUrl": { "type": "string", "description": "Provider logo", "nullable": true }, "vueTemplate": { "type": "string", "description": "Internal url to correct edit template", "nullable": true }, "defaultPackage": { "$ref": "#/components/schemas/OmniumDefaultPackage" }, "numberOfCollisMandatory": { "type": "boolean", "description": "Set if it is mandatory to send in number of collies" }, "shipmentDeliveryType": { "type": "string", "description": "\"Delivery\" or \"PickUp\". \"Delivery\" is used when shipment is sent from store. \"PickUp\" is used when customer collect the shipment from store", "nullable": true }, "translateKey": { "type": "string", "description": "Internal name for this shipment type. Use label for public", "nullable": true }, "label": { "type": "string", "description": "Friendly name for this shipment option.", "nullable": true }, "labelTranslationKey": { "type": "string", "description": "Translation key for this shipment option.", "nullable": true }, "description": { "type": "string", "description": "A user friendly description of this shipment option", "nullable": true }, "isDefaultShipment": { "type": "boolean", "description": "Used internally as a fallback if no other shipment options is found" }, "consigneeType": { "type": "string", "description": "CONSUMER or BUSINESS, is used by providers. Check with correct provider", "nullable": true }, "consignorType": { "type": "string", "description": "CONSUMER or BUSINESS, is used by providers. Check with correct provider", "nullable": true }, "defaultWarehouseCode": { "type": "string", "description": "Set if you use a default warehouse to send from", "nullable": true }, "isWarehouseSetAutomatically": { "type": "boolean", "description": "Used if shipment options is added from Oms, and warehouse should be set automatically" }, "providerServices": { "type": "string", "description": "Provider specific values(comma separated) e.g \"postnord_notification_email\", \"postnord_notification_sms\"", "nullable": true }, "hideInOms": { "type": "boolean", "description": "Not visible in Oms gui" }, "hideFromApi": { "type": "boolean", "description": "Not visible in public api" }, "includeGoodsDescription": { "type": "boolean", "description": "Some providers needs a description of the goods. Then this should be true" }, "externalShippingMethodName": { "type": "string", "description": "Should be used for additional ID or mapping to external systems.", "nullable": true }, "pickUpPoints": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPickUpPoint" }, "description": "Pickup points returned by a provider", "nullable": true }, "servicePointProvider": { "type": "string", "description": "If provider for pickUp/service points differ from ShippingGateway", "nullable": true }, "servicePointRequired": { "type": "boolean", "description": "If this shipment options require a pickUp/service point" }, "getServicePoints": { "type": "boolean", "description": "If we should search for pickUp/service points, based on customer address" }, "printerId": { "type": "string", "description": "Used by providers that support cloud print Only in use if shipping option require special printer, else printer id should be on store. Ask us about setup", "nullable": true }, "shouldParseDescription": { "type": "boolean", "description": "Used by special magento cases. Ask us if needed" }, "validOnMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "The markets this shipment option is valid for", "nullable": true }, "taxRate": { "type": "number", "description": "Tax rate for the options, if differ from market tax rate. Only in used if we should calculate prices", "format": "decimal" }, "shippingTax": { "type": "number", "description": "Tax on shipping cost", "format": "decimal" }, "shippingSubTotalExclTax": { "type": "number", "description": "Shipping cost excl tax", "format": "decimal" }, "discountedPriceTax": { "type": "number", "description": "Discounted price tax", "format": "decimal" }, "discountedPriceExclTax": { "type": "number", "description": "Discounted price excl tax", "format": "decimal" }, "discountAmount": { "type": "number", "description": "Amount of discount given to the customer", "format": "decimal" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "nullable": true } }, "additionalProperties": false, "description": "Information about a specific shipment product, provider(Bring, Postnord, HeltHjem...), returns, price etc." }, "OmniumShipmentPackage": { "type": "object", "properties": { "weightInKg": { "type": "number", "description": "Package weight in Kg", "format": "double" }, "goodsDescription": { "type": "string", "description": "Package description, if provider needs this", "nullable": true }, "dimensions": { "$ref": "#/components/schemas/OmniumShipmentDimensions" }, "shipmentTracking": { "$ref": "#/components/schemas/OmniumShipmentTracking" }, "volume": { "type": "number", "description": "Package volume in Liters", "format": "double", "nullable": true }, "id": { "type": "string", "description": "Package ID", "nullable": true }, "lineItemReferences": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPackageLineItemReference" }, "description": "This lets you bind packages to LineItems and quantity", "nullable": true }, "barcode": { "type": "string", "description": "Package Barcode, for goods reception for example", "nullable": true } }, "additionalProperties": false, "description": "Used by shipping providers to calculate freight cost and space on trucks" }, "OmniumShipmentPatch": { "type": "object", "properties": { "discounts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscount" }, "description": "Shipment discounts", "nullable": true }, "shipmentId": { "type": "string", "description": "Unique identification for shipment", "nullable": true }, "shippingMethodId": { "type": "string", "description": "ID of shipping method", "nullable": true }, "shippingMethodName": { "type": "string", "description": "Name of shipping method", "nullable": true }, "shippingLabel": { "type": "string", "description": "User friendly name - Populated from ShipmentOptions", "nullable": true }, "shippingTax": { "type": "number", "description": "Shipment cost tax", "format": "decimal", "nullable": true }, "shipmentTaxRate": { "type": "number", "description": "Shipment tax rate. If tax is 25%, value here should be 25.00. If not set, default tax rate from market will be used.", "format": "decimal", "nullable": true }, "shipmentTrackingNumber": { "type": "string", "description": "Tracking number from external shipping provider", "nullable": true }, "shipmentTrackingLink": { "type": "string", "description": "Tracking link for external shipping provider", "nullable": true }, "shippingDiscountAmount": { "type": "number", "description": "Total discounts for shipping", "format": "decimal", "nullable": true }, "shippingSubTotal": { "type": "number", "description": "Shipping cost, without discounts", "format": "decimal", "nullable": true }, "shippingTotal": { "type": "number", "description": "Total shipping cost (Calculated, shippingSubTotal - shippingDiscountAmount)", "format": "decimal", "nullable": true, "readOnly": true }, "shippingSubTotalExclTax": { "type": "number", "description": "Shipping cost without discounts excl tax", "format": "decimal", "nullable": true }, "status": { "type": "string", "description": "Shipment status", "nullable": true }, "orderStatus": { "type": "string", "description": "The shipment order status is used in workflows for partial shipments the same way as the order status is used for orders with single shipments.\r\nThis means the values for the shipments OrderStatus could be the same values as the available order statuses.", "nullable": true }, "prevStatus": { "type": "string", "description": "Previous status", "nullable": true }, "subTotal": { "type": "number", "description": "Sum of all lineItems", "format": "decimal", "nullable": true }, "total": { "type": "number", "description": "Sum of all lineItems and shipping cost", "format": "decimal", "nullable": true }, "taxTotal": { "type": "number", "description": "LineItems tax total + shippingTax", "format": "decimal", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse shipment is sent from", "nullable": true }, "pickUpWarehouseCode": { "type": "string", "description": "Warehouse shipment is sent to (optional)", "nullable": true }, "lineItems": { "maxLength": 1000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumOrderLinePatch" }, "description": "Shipment line items", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumOrderAddress" }, "transit": { "type": "boolean", "description": "True if shipment is between two warehouses", "nullable": true }, "comment": { "type": "string", "description": "Shipment comments", "nullable": true }, "returnTrackingNumber": { "type": "string", "description": "Tracking number if return shipment is booked", "nullable": true }, "returnTrackingLink": { "type": "string", "description": "Tracking link if return shipment is booked", "nullable": true }, "returnLabelLink": { "type": "string", "description": "Link to return shipment label", "nullable": true }, "servicePointId": { "type": "string", "description": "Id to third party shipment service/pickup point. If you only have id set this prop. If you have complete info about pickUp point, set PickUpPointInformation object", "nullable": true }, "pickUpPointInformation": { "$ref": "#/components/schemas/OmniumShippingPickUpPoint" }, "expectedDeliveryDate": { "type": "string", "description": "Expected/Requested delivery date for this shipment", "format": "date-time", "nullable": true }, "packages": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPackage" }, "description": "Shipment packages, used by third party shipping providers", "nullable": true }, "expectedShipmentDate": { "type": "string", "description": "Calculated - Expected shipment date (based on ATP)", "format": "date-time", "nullable": true }, "shippingMethodProductId": { "type": "string", "description": "Shipping method product ID", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external shipment IDs", "nullable": true }, "contactPerson": { "$ref": "#/components/schemas/OmniumContactPerson" } }, "additionalProperties": false, "description": "Representing a shipment" }, "OmniumShipmentTracking": { "type": "object", "properties": { "shipmentTrackingNumber": { "type": "string", "description": "Provider tracking number", "nullable": true }, "shipmentTrackingLink": { "type": "string", "description": "Provider tracking link", "nullable": true }, "shipmentLabelLink": { "type": "string", "description": "Link to Shipment label", "nullable": true } }, "additionalProperties": false, "description": "Tracking for each package/colli. Used if shipping provider returns more than one trackinglink/number. Some providers does not support one tracking for shipment with multiple packages" }, "OmniumShippingOption": { "type": "object", "properties": { "shippingMethodName": { "type": "string", "description": "Unique name for this shipping method", "nullable": true }, "shippingCompany": { "type": "string", "description": "Shipping company e.g., PostNord, Bring, UPS", "nullable": true }, "label": { "type": "string", "description": "Shipping option friendly name", "nullable": true }, "description": { "type": "string", "description": "Short description about the shipping option", "nullable": true }, "deliveryTime": { "type": "string", "description": "Shipping provider, approx. delivery time", "nullable": true }, "taxRate": { "type": "number", "description": "Tax rate", "format": "decimal" }, "shippingTax": { "type": "number", "description": "Shipment cost tax, before any discounts", "format": "decimal" }, "shippingSubTotal": { "type": "number", "description": "Shipping cost before any discounts", "format": "decimal" }, "shippingSubTotalExclTax": { "type": "number", "description": "Shipping cost before any discounts, excl tax", "format": "decimal" }, "discountAmount": { "type": "number", "description": "Amount of shipping discount, incl tax", "format": "decimal" }, "discountedPrice": { "type": "number", "description": "The actual shipping cost, if discounted", "format": "decimal" }, "discountedPriceExclTax": { "type": "number", "description": "The actual shipping cost, if discounted, excl tax", "format": "decimal" }, "discountedPriceTax": { "type": "number", "description": "Discounted price tax amount", "format": "decimal" }, "discountLabel": { "type": "string", "description": "Label for discount e.g., \"Free shipping for orders above 1000 Nok\"", "nullable": true }, "pickUpPoints": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShippingPickUpPoint" }, "description": "A list of pickUp points the customer can select from. Can be null", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true } }, "additionalProperties": false, "description": "Shipping option to use on cart / order" }, "OmniumShippingPickUpPoint": { "type": "object", "properties": { "servicePointId": { "type": "string", "description": "Id for this shippingPoint. Id can come from a shippingProvider, and used for lookup.", "nullable": true }, "name": { "type": "string", "description": "A describing name for the pickUp point", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumPickUpPointAddress" }, "openingHours": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPickUpPointOpeningHour" }, "description": "If Opening hours is available, this will containe a list of days and from - to.", "nullable": true } }, "additionalProperties": false, "description": "Object describing a pickUpPoint for a shipment" }, "OmniumSmsMessage": { "type": "object", "properties": { "text": { "type": "string", "description": "Body text (no html)", "nullable": true }, "fromName": { "type": "string", "description": "Email from/sender name", "nullable": true }, "referenceId": { "type": "string", "description": "Reference id for external systems like Sendgrid", "nullable": true }, "to": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of recipients email addresses", "nullable": true }, "storeId": { "type": "string", "description": "Sender Store ID", "nullable": true }, "marketId": { "type": "string", "description": "If email should only be sendt for a specific market(used for translation)", "nullable": true }, "logText": { "type": "string", "description": "Text displayed in log for this event", "nullable": true } }, "additionalProperties": false, "description": "Class for sending sms" }, "OmniumSortField": { "type": "object", "properties": { "field": { "type": "string", "description": "Field to sort by. Available fields depend on the entity type.\r\nExamples for products: \"price\", \"name\", \"modified\", \"created\", \"sortIndex\", \"relevance\"", "nullable": true }, "direction": { "type": "string", "description": "Sort direction: \"asc\" or \"desc\"", "nullable": true } }, "additionalProperties": false, "description": "Sort field and direction for query endpoints. Available field names are entity-specific." }, "OmniumSpecialOpeningHours": { "type": "object", "properties": { "date": { "type": "string", "description": "Date for special opening hours", "format": "date-time" }, "openingHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "closed": { "type": "boolean", "description": "True if store is closed on this day" }, "label": { "type": "string", "description": "Special opening hours label / reason", "nullable": true } }, "additionalProperties": false, "description": "Class for storing special opening hours" }, "OmniumSpecialOpeningHoursPatch": { "type": "object", "properties": { "date": { "type": "string", "description": "Date for special opening hours", "format": "date-time", "nullable": true }, "openingHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "closed": { "type": "boolean", "description": "True if store is closed on this day", "nullable": true }, "label": { "type": "string", "description": "Special opening hours label / reason", "nullable": true } }, "additionalProperties": false, "description": "Class for storing special opening hours" }, "OmniumSplitPurchaseOrderLine": { "type": "object", "properties": { "lineItemId": { "type": "string", "description": "The line item ID to split", "nullable": true }, "quantityToSplit": { "type": "number", "description": "Quantity to move to the new line. The remaining quantity stays on the original line.", "format": "decimal" }, "virtualWarehouseAllocationsToSplit": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVirtualWarehouseAllocationToSplit" }, "description": "Virtual warehouse allocations to move/split.\r\nIf not specified, allocations will be split proportionally based on QuantityToSplit.", "nullable": true }, "newLineItemId": { "type": "string", "description": "Optional: Specify a custom line item ID for the new line. If not provided, a new ID will be generated.", "nullable": true } }, "additionalProperties": false, "description": "Request to split a purchase order line into two lines" }, "OmniumStatsAggregate": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of items", "format": "int64" }, "min": { "type": "number", "description": "Minimum value", "format": "double", "nullable": true }, "max": { "type": "number", "description": "Maximum value", "format": "double", "nullable": true }, "average": { "type": "number", "description": "Average value", "format": "double", "nullable": true }, "sum": { "type": "number", "description": "Sum of values", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Aggregated statistics" }, "OmniumStatsAggregateOmniumBucket": { "type": "object", "properties": { "type": { "type": "string", "description": "Value type", "nullable": true }, "value": { "$ref": "#/components/schemas/OmniumStatsAggregate" } }, "additionalProperties": false, "description": "Bucket" }, "OmniumStore": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Store ID (Unique ID)" }, "name": { "type": "string", "description": "Store or warehouse name", "nullable": true }, "storeGroupId": { "type": "string", "description": "Store group ID", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumStoreAddress" }, "shippingAddress": { "$ref": "#/components/schemas/OmniumStoreAddress" }, "availableOnMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "A list of market ids", "nullable": true }, "availableWarehouses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStoreWarehouse" }, "description": "A list of available warehouses", "nullable": true }, "availableReturnLocations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStoreWarehouse" }, "description": "A list of available return locations", "nullable": true }, "phoneNumber": { "type": "string", "description": "Store phone number", "nullable": true }, "email": { "type": "string", "description": "Store e-mail", "nullable": true }, "comment": { "type": "string", "description": "Comment or description of the store", "nullable": true }, "created": { "type": "string", "description": "Date store is created (utc)", "format": "date-time" }, "modified": { "type": "string", "description": "Date store is modified (utc)", "format": "date-time" }, "url": { "type": "string", "description": "Store URL (URL to home page, web shop, etc)", "nullable": true }, "latitude": { "type": "string", "description": "Location latitude", "nullable": true }, "longitude": { "type": "string", "description": "Location longitude", "nullable": true }, "googlePlaceId": { "type": "string", "description": "ID of Google Place (optional)", "nullable": true }, "mondayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "tuesdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "wednesdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "thursdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "fridayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "saturdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "sundayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHours" }, "additionalOpeningHours": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSpecialOpeningHours" }, "description": "Additional opening hours at specific dates, overriding regular opening hours. For instance during holidays.", "nullable": true }, "useCustomPickLimits": { "type": "boolean", "description": "Indicates if this store uses custom pick limits instead of global settings" }, "storePickLimit": { "type": "string", "description": "Time limit for store to pick an order", "example": "00:00:00" }, "storeExtendedPickLimit": { "type": "string", "description": "Extended time limit for store to pick an order", "example": "00:00:00" }, "customerPickupDeadlineLimit": { "type": "string", "description": "Time limit for customer to pick up their order", "example": "00:00:00" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Store IDs from external systems", "nullable": true }, "externalIdsList": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "IDs from external systems (key value list)", "nullable": true }, "isWarehouse": { "type": "boolean", "description": "True if store can have inventory" }, "isPrimaryWarehouse": { "type": "boolean", "description": "True if this is a primary company warehouse" }, "isPublicVisible": { "type": "boolean", "description": "True if store information should be visible to end customers" }, "isWebWarehouse": { "type": "boolean", "description": "True if warehouse inventory should be available for sale on web" }, "isPrimaryStore": { "type": "boolean", "description": "True if this store is the primary store" }, "isVirtual": { "type": "boolean", "description": "Indicates a virtual warehouse. Only to be used with virtual stock locations in Omnium.", "nullable": true }, "hasVirtualStockLocations": { "type": "boolean", "description": "Indicates that the warehouse has virtual warehouses in front. Only viable for physical warehouses. Only to be used with virtual stock locations in Omnium.", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "bestBets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Best bets", "nullable": true }, "shortDescription": { "type": "string", "description": "Short store description", "nullable": true }, "description": { "type": "string", "description": "Full store description", "nullable": true }, "imageUrl": { "type": "string", "description": "Url to store image", "nullable": true }, "logoUrl": { "type": "string", "description": "Url to store logo", "nullable": true }, "employees": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEmployee" }, "description": "List of employees at store", "nullable": true }, "notificationEmailAddresses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Email addresses used for notifications(recipient)", "nullable": true }, "notificationPhoneNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Phone numbers used for notifications(recipient)", "nullable": true }, "documentFooter": { "type": "string", "description": "Footer in documents like order receipt pdf.\r\nIf store does not have value, fallback to document footer on market", "nullable": true }, "zipCodeRanges": { "maxLength": 5000, "type": "array", "items": { "$ref": "#/components/schemas/OmniumZipCodeRange" }, "description": "Range of zip codes the store delivers to", "nullable": true }, "organizationalNumber": { "type": "string", "description": "Organizational number of the store", "nullable": true }, "iban": { "type": "string", "description": "International bank account number of the store", "nullable": true }, "swift": { "type": "string", "description": "SWIFT code of the store", "nullable": true }, "bank": { "type": "string", "description": "Bank name of the store", "nullable": true }, "accountingDimensionCode": { "type": "string", "description": "Store dimension/account code emitted on accounting postings (e.g. inter-store\r\ncost-transfer lines). Falls back to the store id when not set.", "nullable": true }, "isInactive": { "type": "boolean", "description": "Store is inactive", "nullable": true }, "storeRoleIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Roles the store has", "nullable": true }, "assortmentIncludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "CategoryIds included in the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true }, "assortmentExcludeCategoryIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "CategoryIds excluded from the store's assortment. This is the categoryId from OmniumProductCategory, and is only a link to an existing ProductCategory in Omnium.\r\nWhen posted, if null, the property is not updated. If categories should be removed, send empty list.", "nullable": true }, "defaultOrderType": { "type": "string", "description": "The default order type that will be used when creating a cart for this store", "nullable": true }, "stockBuffer": { "type": "number", "description": "Stock buffer quantity subtracted from available inventory for this store.\r\nNull falls back to the tenant global buffer; 0 explicitly disables fallback.\r\nCan be overridden per product via Properties.", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Physical store, Web shop, Warehouse, or other department of the company" }, "OmniumStoreAddress": { "type": "object", "properties": { "name": { "type": "string", "description": "Store address name", "nullable": true }, "contactPersonName": { "type": "string", "description": "Contact person", "nullable": true }, "streetName": { "type": "string", "description": "Street name", "nullable": true }, "streetNumber": { "type": "string", "description": "Street number", "nullable": true }, "city": { "type": "string", "description": "City", "nullable": true }, "zipcode": { "type": "string", "description": "Zip / postal code", "nullable": true }, "region": { "type": "string", "description": "Region (optional)", "nullable": true }, "regionCode": { "type": "string", "description": "Region code (optional)", "nullable": true }, "country": { "type": "string", "description": "Country", "nullable": true }, "countryCode": { "type": "string", "description": "Country code", "nullable": true }, "email": { "type": "string", "description": "Email", "nullable": true } }, "additionalProperties": false, "description": "Class to store a stores physical address" }, "OmniumStoreOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumStoreOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumStore" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumStorePatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Store ID (Unique ID)", "nullable": true }, "name": { "type": "string", "description": "Store or warehouse name", "nullable": true }, "storeGroupId": { "type": "string", "description": "Store group ID", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumStoreAddress" }, "shippingAddress": { "$ref": "#/components/schemas/OmniumStoreAddress" }, "availableOnMarkets": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "A list of market ids", "nullable": true }, "availableWarehouses": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStoreWarehousePatch" }, "description": "A list of available warehouses", "nullable": true }, "availableReturnLocations": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumStoreWarehousePatch" }, "description": "A list of available return locations", "nullable": true }, "phoneNumber": { "type": "string", "description": "Store phone number", "nullable": true }, "email": { "type": "string", "description": "Store e-mail", "nullable": true }, "comment": { "type": "string", "description": "Comment or description of the store", "nullable": true }, "created": { "type": "string", "description": "Date store is created (utc)", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date store is modified (utc)", "format": "date-time", "nullable": true }, "url": { "type": "string", "description": "Store URL (URL to home page, web shop, etc)", "nullable": true }, "latitude": { "type": "string", "description": "Location latitude", "nullable": true }, "longitude": { "type": "string", "description": "Location longitude", "nullable": true }, "googlePlaceId": { "type": "string", "description": "ID of Google Place (optional)", "nullable": true }, "mondayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "tuesdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "wednesdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "thursdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "fridayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "saturdayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "sundayOpeningHours": { "$ref": "#/components/schemas/OmniumOpeningHoursPatch" }, "additionalOpeningHours": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumSpecialOpeningHoursPatch" }, "description": "Additional opening hours at specific dates, overriding regular opening hours. For instance during holidays.", "nullable": true }, "useCustomPickLimits": { "type": "boolean", "description": "Indicates if this store uses custom pick limits instead of global settings", "nullable": true }, "storePickLimit": { "type": "string", "description": "Time limit for store to pick an order", "nullable": true, "example": "00:00:00" }, "storeExtendedPickLimit": { "type": "string", "description": "Extended time limit for store to pick an order", "nullable": true, "example": "00:00:00" }, "customerPickupDeadlineLimit": { "type": "string", "description": "Time limit for customer to pick up their order", "nullable": true, "example": "00:00:00" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Store IDs from external systems", "nullable": true }, "externalIdsList": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "IDs from external systems (key value list)", "nullable": true }, "isWarehouse": { "type": "boolean", "description": "True if store can have inventory", "nullable": true }, "isPrimaryWarehouse": { "type": "boolean", "description": "True if this is a primary company warehouse", "nullable": true }, "isPublicVisible": { "type": "boolean", "description": "True if store information should be visible to end customers", "nullable": true }, "isWebWarehouse": { "type": "boolean", "description": "True if warehouse inventory should be available for sale on web", "nullable": true }, "isPrimaryStore": { "type": "boolean", "description": "True if this store is the primary store", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "shortDescription": { "type": "string", "description": "Short store description", "nullable": true }, "description": { "type": "string", "description": "Full store description", "nullable": true }, "imageUrl": { "type": "string", "description": "Url to store image", "nullable": true }, "logoUrl": { "type": "string", "description": "Url to store logo", "nullable": true }, "employees": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEmployee" }, "description": "List of employees at store", "nullable": true }, "notificationEmailAddresses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Email addresses used for notifications(recipient)", "nullable": true }, "notificationPhoneNumbers": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Phone numbers used for notifications(recipient)", "nullable": true }, "documentFooter": { "type": "string", "description": "Footer in documents like order receipt pdf.\r\nIf store does not have value, fallback to document footer on market", "nullable": true }, "isInactive": { "type": "boolean", "description": "Store is inactive (soft delete)", "nullable": true }, "storeRoleIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Roles the store has", "nullable": true }, "organizationalNumber": { "type": "string", "description": "Organizational number of the store", "nullable": true }, "accountingDimensionCode": { "type": "string", "description": "Store dimension/account code emitted on accounting postings (e.g. inter-store\r\ncost-transfer lines). Falls back to the store id when not set.", "nullable": true }, "stockBuffer": { "type": "number", "description": "Stock buffer quantity subtracted from available inventory for this store.\r\nNull leaves the existing value unchanged (use OmniumStore PUT to clear back to market/global fallback).", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Physical store, Web shop, Warehouse, or other department of the company" }, "OmniumStoreSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items pr page", "format": "int32" }, "page": { "type": "integer", "description": "Page to fetch", "format": "int32" }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by markets", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Search by individual stores", "nullable": true }, "storeGroupId": { "type": "string", "description": "Search by store group", "nullable": true }, "marketGroupId": { "type": "string", "description": "Search by market group", "nullable": true }, "searchText": { "type": "string", "description": "Search text", "nullable": true }, "isWarehouse": { "type": "boolean", "description": "If true, only warehouses will be returned, if false, only stores not warehouse will be returned. Null returns all stores.", "nullable": true }, "includeInactive": { "type": "boolean", "description": "If null or false all inactive stores are excluded from search result", "nullable": true }, "isInactive": { "type": "boolean", "description": "Null returns all stores, true returns only inactive stores, false returns only active stores (isInactive false or null).", "nullable": true }, "zipCodeRangeFilter": { "type": "integer", "description": "Return only stores with ZipCode Range including the specified ZipCode", "format": "int32", "nullable": true }, "email": { "type": "string", "description": "Search store by email", "nullable": true }, "createdFrom": { "type": "string", "description": "Stores created from date (utc)", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Stores created before date (utc)", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Stores modified from date (utc)", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Stores modified before date (utc)", "format": "date-time", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search stores with external IDs", "nullable": true }, "property": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "sortOrder": { "type": "string", "description": "Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending, ZipCodeMatchDescending", "nullable": true } }, "additionalProperties": false, "description": "Search request object for stores" }, "OmniumStoreUpdateResult": { "type": "object", "properties": { "isModified": { "type": "boolean" }, "totalCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "unchangedCount": { "type": "integer", "format": "int32" }, "notFoundCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumStoreWarehouse": { "type": "object", "properties": { "warehouseCode": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Available warehouse for a store" }, "OmniumStoreWarehousePatch": { "type": "object", "properties": { "warehouseCode": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Available warehouse for a store" }, "OmniumSubPayment": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the sub-payment type.", "nullable": true }, "moneySubTotal": { "type": "number", "description": "Subtotal for this payment sub-type.", "format": "decimal" }, "moneyCaptured": { "type": "number", "description": "Amount that has been captured/settled.", "format": "decimal" }, "moneyInAdvance": { "type": "number", "description": "Amount paid in advance (deposits, prepayments).", "format": "decimal" }, "moneyReserved": { "type": "number", "description": "Amount reserved but not yet captured (authorizations).", "format": "decimal" } }, "additionalProperties": false, "description": "Represents a sub-category of a payment method with detailed breakdown." }, "OmniumSubscription": { "required": [ "cartTemplate", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique subscription ID", "nullable": true }, "customerId": { "type": "string", "description": "The ID of the customer - should be an unique value", "nullable": true }, "customerNumber": { "type": "string", "description": "The customer number", "nullable": true }, "customerName": { "type": "string", "description": "Name of customer", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone number with prefix. e.g. +4740000000", "nullable": true }, "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "startDate": { "type": "string", "description": "Start date of the subscription", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "End date of the subscription", "format": "date-time", "nullable": true }, "nextOrderDate": { "type": "string", "description": "Date when next order should be created", "format": "date-time", "nullable": true }, "subscriptionOrderCreationTime": { "type": "string", "description": "Time of day when the subscription order should be created", "example": "00:00:00" }, "intervalDays": { "type": "integer", "description": "Interval in days between each order", "format": "int32" }, "schedule": { "type": "string", "description": "Subscription schedule - Cron expression", "nullable": true, "deprecated": true }, "status": { "type": "string", "description": "Subscription current status" }, "cartTemplate": { "$ref": "#/components/schemas/OmniumCart" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties", "nullable": true }, "errors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumEntityError" }, "description": "Errors and warnings", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External IDs", "nullable": true }, "payments": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPayment" }, "description": "Subscription payment - recurring payment reference", "nullable": true }, "modifiedBy": { "type": "string", "description": "User (or system) that last modified the entity", "nullable": true }, "isAnonymized": { "type": "boolean", "description": "Marked as anonymized s" }, "modified": { "type": "string", "description": "Last time the subscription was updated", "format": "date-time" }, "created": { "type": "string", "description": "When the subscription was created", "format": "date-time" }, "lastFailedVerificationAttempt": { "type": "string", "description": "When subscription verification last failed", "format": "date-time", "nullable": true }, "numberOfVerificationAttempts": { "type": "integer", "description": "Number of failed verification attempts. Should be reset when a successful verification attempt", "format": "int32", "nullable": true }, "createPendingOrders": { "type": "boolean", "description": "Create pending orders for subscription" }, "numberOfPendingOrders": { "type": "integer", "description": "Number of pending orders to create (Default: 3)", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Omnium subscription model" }, "OmniumSubscriptionOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSubscription" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumSubscriptionSearchRequest": { "type": "object", "properties": { "customerEmail": { "type": "string", "description": "Customer e-mail", "nullable": true }, "customerPhone": { "type": "string", "description": "Customer phone number", "nullable": true }, "customerName": { "type": "string", "description": "Customer name", "nullable": true }, "customerNumber": { "type": "string", "description": "Customer Number", "nullable": true }, "customerId": { "type": "string", "description": "Customer Id", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Limit search by store IDs", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Limit search by store IDs", "nullable": true }, "take": { "type": "integer", "description": "Number of orders to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "property": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search subscriptions with external IDs", "nullable": true } }, "additionalProperties": false, "description": "Subscription search request" }, "OmniumSupplier": { "type": "object", "properties": { "id": { "type": "string", "description": "Supplier ID", "nullable": true }, "name": { "type": "string", "description": "Supplier company name", "nullable": true }, "omniumStoreId": { "type": "string", "description": "Only use if the supplier is a store in Omnium", "nullable": true }, "taxId": { "type": "string", "description": "Tax ID, or other governmental identification number", "nullable": true }, "contacts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumContactPerson" }, "description": "Supplier contact persons", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumAddress" }, "description": "Additional addresses associated with the supplier (e.g., billing, delivery).", "nullable": true }, "email": { "type": "string", "description": "Supplier e-mail", "nullable": true }, "phone": { "type": "string", "description": "Supplier phone number", "nullable": true }, "created": { "type": "string", "description": "Date created", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Date modified", "format": "date-time", "nullable": true }, "preferredLanguage": { "type": "string", "description": "Supplier language", "nullable": true }, "preferredCurrency": { "type": "string", "description": "Supplier currency", "nullable": true }, "defaultLeadTime": { "type": "integer", "description": "Supplier default lead time", "format": "int32", "nullable": true }, "defaultLeadTimeSafetyMarginDays": { "type": "integer", "description": "Safety margin added to the lead time to give an extra inventory buffer", "format": "int32", "nullable": true }, "defaultOrderIntervalDays": { "type": "integer", "description": "Purchase interval in days (number of days to multiply by average daily sales)", "format": "int32", "nullable": true }, "paymentTerms": { "type": "integer", "description": "Standard payment terms agreed with the supplier, expressed as number of days.", "format": "int32", "nullable": true }, "incoterms": { "type": "string", "description": "The Incoterms agreement that applies to purchases from this supplier (e.g., FOB, DDP).", "nullable": true }, "shippingProvider": { "type": "string", "description": "The supplier’s standard freight provider (e.g., PostNord, DHL, Loomis).", "nullable": true }, "shipmentCost": { "type": "number", "description": "Default shipment costs applied when ordering from this supplier. \r\nCan represent either a fixed cost or a baseline for freight calculation.", "format": "decimal" }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Available store IDs", "nullable": true }, "properties": { "maxLength": 500, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Customer properties, (key values)", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external supplier IDs", "nullable": true }, "versionId": { "type": "string", "description": "Version ID", "nullable": true }, "previousVersionId": { "type": "string", "description": "Previous Version ID", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Tags used for categorization or search purposes.", "nullable": true }, "storeGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of store group IDs linked to this supplier.", "nullable": true }, "minimumOrderAmount": { "type": "number", "description": "Minimum total order amount for purchase orders to this supplier.", "format": "decimal", "nullable": true }, "maximumOrderAmount": { "type": "number", "description": "Maximum total order amount for purchase orders to this supplier.", "format": "decimal", "nullable": true }, "assortmentCodes": { "type": "array", "items": { "type": "string" }, "description": "Assortment codes that define which products can be ordered from this supplier.", "nullable": true } }, "additionalProperties": false, "description": "Company that delivers purchase orders" }, "OmniumSupplierOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSupplier" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumSupplierSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Number of items to take", "format": "int32" }, "page": { "type": "integer", "description": "Page (Fetches from [Page * Take] to [(Page + 1) * Take])", "format": "int32" }, "createdFrom": { "type": "string", "description": "Project created after date", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "description": "Project created before date", "format": "date-time", "nullable": true }, "modifiedFrom": { "type": "string", "description": "Project modified after date", "format": "date-time", "nullable": true }, "modifiedTo": { "type": "string", "description": "Project modified before date", "format": "date-time", "nullable": true }, "supplierId": { "type": "string", "description": "Supplier ID", "nullable": true }, "searchText": { "type": "string", "description": "Free text search", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Filter by store IDs", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List with custom properties to search for", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search by external IDs", "nullable": true } }, "additionalProperties": false, "description": "Supplier search request" }, "OmniumTagSettings": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "translationKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumTermsAggregationData": { "type": "object", "properties": { "key": { "type": "string", "description": "Term key", "nullable": true, "readOnly": true }, "docCount": { "type": "integer", "description": "Number of items", "format": "int64", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Terms aggregations" }, "OmniumTermsAggregationDataListOmniumBucket": { "type": "object", "properties": { "type": { "type": "string", "description": "Value type", "nullable": true }, "value": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumTermsAggregationData" }, "description": "Value", "nullable": true } }, "additionalProperties": false, "description": "Bucket" }, "OmniumTimeEntry": { "type": "object", "properties": { "id": { "type": "string", "description": "Id", "nullable": true }, "projectId": { "type": "string", "description": "Id of related project", "nullable": true }, "userId": { "type": "string", "description": "Id of the user connected to the time entry", "nullable": true }, "activityId": { "type": "string", "description": "ActivityId", "nullable": true }, "activityName": { "type": "string", "description": "Name of the activity", "nullable": true }, "date": { "type": "string", "description": "Date of the time entry", "format": "date-time", "nullable": true }, "hours": { "type": "integer", "description": "The number of hours for the time entry", "format": "int32", "nullable": true }, "comment": { "type": "string", "description": "Comment", "nullable": true }, "timeCode": { "type": "string", "description": "Time code", "nullable": true }, "timeCodeName": { "type": "string", "description": "Time code name", "nullable": true }, "status": { "type": "string", "description": "Status [Active, Approved, Draft]", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external ids connected to the time entry", "nullable": true } }, "additionalProperties": false, "description": "Time entry related to project." }, "OmniumTimeEntrySearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "ids": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true }, "projectId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "activityId": { "type": "string", "nullable": true }, "activityName": { "type": "string", "nullable": true }, "dateFrom": { "type": "string", "format": "date-time", "nullable": true }, "dateTo": { "type": "string", "format": "date-time", "nullable": true }, "timeCode": { "type": "string", "nullable": true }, "timeCodeName": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumTokenResponse": { "type": "object", "properties": { "accessToken": { "type": "string", "nullable": true }, "tokenType": { "type": "string", "nullable": true }, "expiresIn": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OmniumTranslationKeys": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "translationKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumTriggerRequest": { "required": [ "triggerName" ], "type": "object", "properties": { "triggerName": { "type": "string", "description": "Trigger name" }, "referenceId": { "type": "string", "description": "Optional: ID to a reference in context of the trigger. An order or customer would typically be a reference.", "nullable": true } }, "additionalProperties": false, "description": "Used for triggering actions specifically configured for the tenant" }, "OmniumUnitConversion": { "type": "object", "properties": { "isoCode": { "type": "string", "nullable": true }, "ociCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumUnitConversionList": { "type": "object", "properties": { "unitConversionListName": { "type": "string", "nullable": true }, "unitConversionListId": { "type": "string", "nullable": true }, "unitConversions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumUnitConversion" }, "nullable": true } }, "additionalProperties": false }, "OmniumUpdateLineItemStatusPatch": { "required": [ "lineItemUpdates" ], "type": "object", "properties": { "status": { "type": "string", "description": "New status to update to", "nullable": true }, "lineItemUpdates": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumLineItemUpdate" }, "description": "Line items to update" }, "userId": { "type": "string", "description": "User ID", "nullable": true }, "shipmentInfo": { "$ref": "#/components/schemas/OmniumUpdateShipmentInfo" }, "isShippingCostKeptForExistingShipment": { "type": "boolean", "description": "Is shipping cost kept for existing shipment. If true, shipping cost will not be transferred to the new partial shipment. If false, shipping cost will be transferred if new shipment is completed and existing shipment is not completed" }, "enqueue": { "type": "boolean", "description": "When true, the update is processed asynchronously via a Service Bus queue and the API returns 202 Accepted immediately.\r\nDefaults to false (synchronous processing), but is the recommended way of using this endpoint.", "nullable": true } }, "additionalProperties": false, "description": "Update line item" }, "OmniumUpdateProjectProductStatusRequest": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID", "nullable": true }, "productStatusUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductStatusUpdate" }, "description": "Per-product status updates", "nullable": true } }, "additionalProperties": false, "description": "Request model for updating the status of individual products in a project" }, "OmniumUpdateRentalProductPriceRequest": { "required": [ "rentalProductId", "unitPrice" ], "type": "object", "properties": { "rentalProductId": { "type": "string", "description": "The SKU ID of the rental product whose price should be updated" }, "unitPrice": { "type": "number", "description": "The new unit price", "format": "decimal" } }, "additionalProperties": false, "description": "Request for updating a single price (daily rate or deposit) on a rental product" }, "OmniumUpdateShipmentInfo": { "type": "object", "properties": { "shipmentMethodName": { "type": "string", "description": "Set this if shipmentMethodName is changed, or this is a new shipment", "nullable": true }, "trackingUrl": { "type": "string", "description": "Tracking url from carrier", "nullable": true }, "trackingNumber": { "type": "string", "description": "Tracking number from carrier", "nullable": true }, "labelLink": { "type": "string", "description": "Link to shipping label", "nullable": true }, "returnLabelLink": { "type": "string", "description": "link to return shipping label", "nullable": true }, "returnTrackingLink": { "type": "string", "description": "Link to return tracking", "nullable": true }, "returnTrackingNumber": { "type": "string", "description": "Return tracking number", "nullable": true }, "shipmentId": { "type": "string", "description": "Shipment to update. If id does not exists in Omnium, new shipment is created(only for partially update) else first shipment is used", "nullable": true }, "orderStatus": { "type": "string", "description": "If set, order status will be updated on shipment only, unless all shipments have same status", "nullable": true }, "comment": { "type": "string", "description": "If set, comment will be replaced on shipment", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "Add or update external IDs to shipment", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Add or update external IDs to shipment", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse shipment is sent from", "nullable": true }, "shippingMethodProductId": { "type": "string", "description": "If set, shipping method product ID will be replaced on shipment", "nullable": true }, "packages": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumShipmentPackage" }, "description": "Shipment packages, with dimensions and optional tracking information", "nullable": true }, "servicePointId": { "type": "string", "description": "Id to third party shipment service/pickup point. If you only have id set this prop. If you have complete info about pickUp point, set PickUpPointInformation object", "nullable": true }, "pickUpPointInformation": { "$ref": "#/components/schemas/OmniumShippingPickUpPoint" }, "clearScheduledOrderStatus": { "type": "boolean", "description": "If true, clears the scheduled order status update (UpdateStatusDate and NextOrderStatus) on the shipment.", "nullable": true } }, "additionalProperties": false, "description": "Class for updating shipment method and tracking info" }, "OmniumUpdateStatusPatch": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string", "description": "New status to update to" }, "userId": { "type": "string", "description": "User ID", "nullable": true }, "shipmentInfo": { "$ref": "#/components/schemas/OmniumUpdateShipmentInfo" }, "returnId": { "type": "string", "description": "For return order workflows (ReturnOrderForm.Id)", "nullable": true }, "skipRunWorkflow": { "type": "boolean", "description": "If set to true, order will only be saved, and no workflows will run" }, "executeWorkFlowAsync": { "type": "boolean", "description": "When true, the status update and workflow are processed asynchronously via a Service Bus queue.\r\nThe API returns 202 Accepted immediately without waiting for the workflow to complete.\r\nDefaults to false (synchronous processing). Ignored when Omnium.Public.Orders.Models.OmniumUpdateStatusPatch.SkipRunWorkflow is true." } }, "additionalProperties": false, "description": "Update status patch" }, "OmniumUserModel": { "type": "object", "properties": { "id": { "type": "string", "description": "User unique ID", "nullable": true }, "externalIds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external user IDs. Could be ids from other SCIM providers", "nullable": true }, "b2CId": { "type": "string", "description": "Azure B2C Id for user", "nullable": true }, "roles": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "List of roles assigned to user", "nullable": true }, "firstName": { "type": "string", "description": "User's first name", "nullable": true }, "lastName": { "type": "string", "description": "User's last name", "nullable": true }, "email": { "type": "string", "description": "User's contact email", "nullable": true }, "phone": { "type": "string", "description": "User's phone number", "nullable": true }, "projectTypes": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Project types of interest to user", "nullable": true }, "lastLogin": { "type": "string", "description": "Last time the user logged in to Omnium", "format": "date-time" }, "imageUrl": { "type": "string", "description": "Url to user image", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Custom properties for user", "nullable": true }, "multiEmployeeUser": { "type": "boolean", "description": "Set to true for users that are shared between multiple users. Each employee should have a pin code to identify itself." }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumEmployee" }, "description": "List of Employees sharing this user entity.", "nullable": true } }, "additionalProperties": false, "description": "The OmniumUserModel contains data about users in Omnium" }, "OmniumUserPatch": { "type": "object", "properties": { "roles": { "maxLength": 2000, "type": "array", "items": { "type": "string" }, "description": "List of roles assigned to user", "nullable": true }, "firstName": { "type": "string", "description": "User's first name", "nullable": true }, "lastName": { "type": "string", "description": "User's last name", "nullable": true }, "email": { "type": "string", "description": "User's contact email", "nullable": true }, "phone": { "type": "string", "description": "User's phone number", "nullable": true }, "projectTypes": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "Project types of interest to user", "nullable": true }, "imageUrl": { "type": "string", "description": "Url to user image", "nullable": true }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "User properties, (key values)", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true } }, "additionalProperties": false, "description": "OmniumUserPatch is used to patch existing omnium users" }, "OmniumValidationError": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "translateKey": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "description": "Stable, machine-readable code identifying the validation error (e.g. \"ProductNotActive\",\r\n\"InsufficientInventory\"). Use this to branch on the error programmatically instead of\r\nparsing Omnium.Public.Validation.Models.OmniumValidationError.Message. This is the recommended field for integrations; prefer it\r\nover Omnium.Public.Validation.Models.OmniumValidationError.TranslateKey, which is a localization resource key and not a stable contract.", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumValidationResult": { "type": "object", "properties": { "isValidatedSuccessful": { "type": "boolean" }, "validationErrors": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationWarnings": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumValidationError" }, "nullable": true }, "validationMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumValueAggregate": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "valueAsString": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Value aggregations" }, "OmniumValueAggregateOmniumBucket": { "type": "object", "properties": { "type": { "type": "string", "description": "Value type", "nullable": true }, "value": { "$ref": "#/components/schemas/OmniumValueAggregate" } }, "additionalProperties": false, "description": "Bucket" }, "OmniumVariantPatch": { "type": "object", "properties": { "id": { "type": "string", "description": "Product unique ID", "nullable": true }, "productId": { "type": "string", "description": "Product ID", "nullable": true }, "skuId": { "type": "string", "description": "Product unique ID", "nullable": true }, "ean": { "type": "string", "description": "EAN code", "nullable": true, "deprecated": true }, "gtins": { "type": "array", "items": { "type": "string" }, "description": "GTIN codes", "nullable": true }, "name": { "type": "string", "description": "Product name", "nullable": true }, "published": { "type": "string", "description": "Date product is published", "format": "date-time", "nullable": true }, "stopPublished": { "type": "string", "description": "Product activation end date. Can be null", "format": "date-time", "nullable": true }, "discontinued": { "type": "string", "description": "Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "description": "True if product is active. False if it should be hidden from customers.", "nullable": true }, "catalog": { "type": "string", "description": "Catalog name", "nullable": true }, "mainImageUrl": { "type": "string", "description": "Product image url", "nullable": true }, "assets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAsset" }, "description": "Product media files", "nullable": true }, "keepExistingAssets": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'Assets' list. If true, new assets will be added to the existing list of assets. 'True' by default.", "nullable": true }, "seoInfo": { "$ref": "#/components/schemas/OmniumSeoInfo" }, "entryType": { "type": "string", "description": "Product entry type", "nullable": true }, "expectedDeliveryDate": { "type": "string", "description": "Expected delivery date", "format": "date-time", "nullable": true }, "isSku": { "type": "boolean", "description": "True if product is stock keeping unit / product or variant that can be sold", "nullable": true }, "isBundle": { "type": "boolean", "description": "True if product is a bundle of other products (unlike package, price is sum of components)", "nullable": true }, "isPackage": { "type": "boolean", "description": "True if product is package of other products (unlike bundle, price is specified for package)", "nullable": true }, "isKit": { "type": "boolean", "description": "True if product is a kit (product composed of other products, assembled at fulfillment)", "nullable": true }, "isWriteProtected": { "type": "boolean", "description": "True if product is write protected by user. PIM integrations should not override product information.", "nullable": true }, "isInStock": { "type": "boolean", "description": "True if product is in stock", "nullable": true }, "catalogNodes": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Catalog nodes (if multiple)", "nullable": true }, "minQuantity": { "type": "number", "description": "Minimum inventory quantity (point of reordering)", "format": "decimal", "nullable": true }, "maxQuantity": { "type": "number", "description": "Max inventory quantity (what should be in stock after new supply)", "format": "decimal", "nullable": true }, "weight": { "type": "number", "description": "Product weight", "format": "double", "nullable": true }, "taxCategory": { "type": "string", "description": "Product tax category", "nullable": true }, "taxGroupCode": { "type": "string", "description": "References a TaxGroup.Code in the tenant's chart of tax groups.\r\nWhen null, the tenant's DefaultTaxGroupCode applies (if feature is enabled).\r\nHas no effect when AccountingSettings.TaxGroupsEnabled = false.", "nullable": true }, "taxRate": { "type": "number", "description": "Per-product VAT rate used as a fallback when tax groups are not configured.\r\nApplied to any price that has no TaxRate of its own at save time.\r\nTax-group resolution takes precedence when enabled.", "format": "decimal", "nullable": true }, "associatedProducts": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Associated product IDs", "nullable": true }, "prices": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPrice" }, "description": "List of all product prices - all currencies, campaigns, customer prices etc", "nullable": true }, "pricesMergeMode": { "$ref": "#/components/schemas/OmniumPatchMergeMode" }, "properties": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "List of properties. Key value pairs with any non strongly typed properties.", "nullable": true }, "propertiesRemovalConditions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Specifies conditions for removing existing properties before proceeding with the patch operation.\r\nEach item in this list is a property specification with multiple attributes that must all match an existing property for it to be removed.\r\n
\r\nFor instance, a condition\r\n{\r\n \"KeyGroup\": \"KeyGroupToRemove\",\r\n \"ValueType\": \"List\"\r\n}\r\n
\r\nwill remove properties only if both KeyGroup == \"KeyGroupToRemove\" and ValueType == \"List\".\r\n
\r\nMultiple items in this list are evaluated with \"OR\" logic, so any matching condition will trigger removal.", "nullable": true }, "keepExistingCustomProperties": { "type": "boolean", "description": "Set to 'false' if you want to update the whole 'properties' list. If true, new properties will be added to the existing list of properties. 'True' by default.", "nullable": true }, "dontOverwriteExistingPropertyValues": { "type": "boolean", "description": "Set to 'true' if you want to skip updating properties that already exists and has a value. If you want to add values to a list/multiselect property, make sure this option is set to 'true' along with valueType: 'List' or 'DropDown'. Otherwise the list property will be overwritten.", "nullable": true }, "marketIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of available market IDs", "nullable": true }, "productOptions": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductOption" }, "description": "Available product options for the product", "nullable": true }, "storeIds": { "maxLength": 1000, "type": "array", "items": { "type": "string" }, "description": "List of available store IDs", "nullable": true }, "marketGroupIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of available market group IDs", "nullable": true }, "language": { "type": "string", "description": "Product language", "nullable": true }, "location": { "type": "string", "description": "The location of the product in the warehouse.", "nullable": true }, "color": { "type": "string", "description": "Product color", "nullable": true }, "brand": { "type": "string", "description": "Product brand", "nullable": true }, "size": { "type": "string", "description": "Product size", "nullable": true }, "shortDescription": { "type": "string", "description": "Short product description", "nullable": true }, "description": { "type": "string", "description": "Product description", "nullable": true }, "specification": { "type": "string", "description": "Product Specification", "nullable": true }, "supplierName": { "type": "string", "description": "Name of main product supplier", "nullable": true }, "supplierId": { "type": "string", "description": "Main supplier ID", "nullable": true }, "supplierSkuId": { "type": "string", "description": "External product ID from supplier, used when creating purchase orders", "nullable": true }, "supplierColor": { "type": "string", "description": "Color from supplier", "nullable": true }, "supplierPackagingUnit": { "type": "string", "description": "Supplier packaging quantity", "nullable": true }, "supplierPackagingQuantity": { "type": "number", "description": "Supplier packaging quantity", "format": "decimal", "nullable": true }, "allowSupplierPackageBreak": { "type": "boolean", "description": "Indicates if supplier packages can be split to order quantities smaller than the full package size.", "nullable": true }, "additionalSuppliers": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductSupplier" }, "description": "List of additional product suppliers", "nullable": true }, "sizeType": { "type": "string", "description": "Product size type", "nullable": true }, "unit": { "type": "string", "description": "Product unit, used for describing what unit the quantities are in", "nullable": true }, "units": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductUnit" }, "description": "List of additional units", "nullable": true }, "colli": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductColli" }, "description": "List of colli, used for shipment", "nullable": true }, "relatedProducts": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumRelatedProduct" }, "description": "Related products", "nullable": true }, "season": { "type": "string", "description": "Product season", "nullable": true }, "badges": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductBadge" }, "description": "List of product badges or labels to display on product", "nullable": true }, "sortIndexBoost": { "type": "integer", "description": "Sort index set by API / GUI", "format": "int32", "nullable": true }, "isBackorder": { "type": "boolean", "description": "If true, the product have no reorder level, and will usually not be in stock", "nullable": true }, "isPriceLocked": { "type": "boolean", "description": "When true, the price on order lines created from this product will be locked and not recalculated.", "nullable": true }, "isMainProductVariant": { "type": "boolean", "description": "If true, this variant should represent the product in flattened variant lists", "nullable": true }, "isSerializableProduct": { "type": "boolean", "description": "If true, the product is serializable, and order line should contain serial number when completed", "nullable": true }, "alternativeProductName": { "type": "string", "description": "Alternative product name", "nullable": true }, "cost": { "type": "number", "description": "Product net cost", "format": "decimal", "nullable": true }, "costCurrency": { "type": "string", "description": "Currency code. E.g. USD, EUR, NOK", "nullable": true }, "components": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductComponent" }, "description": "Product components (used when product is a package)", "nullable": true }, "productType": { "type": "string", "description": "Type of product", "nullable": true }, "tags": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "List of tag IDs", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "List of external product IDs. Could be ids in eCommerce platform etc", "nullable": true }, "isNotRatable": { "type": "boolean", "description": "Set to true if this product should be excluded from rating emails/forms", "nullable": true }, "excludeFromPromotions": { "type": "boolean", "description": "Set to true if this product should be excluded from promotions", "nullable": true }, "salesStartDate": { "type": "string", "description": "Embargo date: product cannot be sold before this date", "format": "date-time", "nullable": true }, "fixedPriceCode": { "type": "string", "description": "Price protection category (e.g. book law)", "nullable": true }, "fixedPriceEndDate": { "type": "string", "description": "Discounts are blocked until this date", "format": "date-time", "nullable": true }, "discountBlocked": { "type": "boolean", "description": "Permanent discount prohibition", "nullable": true }, "gender": { "type": "string", "description": "Gender", "nullable": true }, "countryOfOrigin": { "type": "string", "description": "Country of origin", "nullable": true }, "isVirtual": { "type": "boolean", "description": "Virtual products will not affect inventory.", "nullable": true }, "assortmentCodes": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumAssortmentCode" }, "description": "Assortment codes for the product", "nullable": true }, "fieldsToForceNull": { "type": "array", "items": { "type": "string" }, "description": "Force nullable product fields to null. Use the property path, e.g. \"SeoInfo.Description\".", "nullable": true }, "freightClass": { "type": "string", "description": "Freight class", "nullable": true }, "customsCode": { "type": "string", "description": "Customs code for the product", "nullable": true } }, "additionalProperties": false, "description": "SkuId is required. If not set, the patch request will be skipped" }, "OmniumVatGroup": { "type": "object", "properties": { "name": { "type": "string", "description": "Name or description of this VAT group.", "nullable": true }, "amount": { "type": "number", "description": "Total amount for transactions in this VAT group.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of transactions in this VAT group.", "format": "int32" }, "vatValue": { "type": "number", "description": "VAT rate percentage (e.g., 25.00 for 25%).", "format": "decimal", "nullable": true } }, "additionalProperties": false, "description": "Represents sales grouped by VAT rate or tax code." }, "OmniumVatGroupRefund": { "type": "object", "properties": { "name": { "type": "string", "description": "Name or description of this VAT group.", "nullable": true }, "amount": { "type": "number", "description": "Total refund amount for this VAT group.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of refund transactions in this VAT group.", "format": "int32" }, "vatValue": { "type": "number", "description": "VAT rate percentage (e.g., 25.00 for 25%).", "format": "decimal" } }, "additionalProperties": false, "description": "Represents refunds/returns grouped by VAT rate." }, "OmniumVersionListItem": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "id": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "versionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumVirtualWarehouseAllocation": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id for the allocation - will default to a guid", "nullable": true }, "quantity": { "type": "number", "description": "Number of items", "format": "decimal" }, "deliveredQuantity": { "type": "number", "description": "Quantity of the line item that has been delivered", "format": "decimal" }, "warehouseCode": { "type": "string", "description": "Virtual Warehouse Code", "nullable": true } }, "additionalProperties": false, "description": "Virtual Warehouse Allocation" }, "OmniumVirtualWarehouseAllocationToSplit": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique Id of the allocation to split. If specified, takes priority over WarehouseCode.", "nullable": true }, "quantity": { "type": "number", "description": "Quantity to move from this allocation to the new line.", "format": "decimal" }, "warehouseCode": { "type": "string", "description": "Warehouse code of the allocation to split. Used when Id is not specified.", "nullable": true } }, "additionalProperties": false, "description": "Virtual Warehouse Allocation identifier for split operations.\r\nUse either Id or WarehouseCode to identify which allocation to split." }, "OmniumVisitingaddress": { "type": "object", "properties": { "streetName": { "type": "string", "nullable": true }, "streetNumber": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OmniumVoucher": { "type": "object", "properties": { "id": { "type": "string", "description": "Voucher ID", "nullable": true }, "customerId": { "type": "string", "description": "Id of customer owning the voucher", "nullable": true }, "voucherNumber": { "type": "string", "description": "Voucher number", "nullable": true }, "amount": { "type": "number", "description": "The amount the voucher is worth", "format": "decimal" }, "currency": { "type": "string", "description": "Currency of the voucher amount", "nullable": true }, "status": { "type": "string", "description": "Voucher status [Available, Applied, Redeemed, Expired]", "nullable": true }, "created": { "type": "string", "description": "Created date", "format": "date-time", "nullable": true }, "modified": { "type": "string", "description": "Modified date", "format": "date-time", "nullable": true }, "expiryDate": { "type": "string", "description": "Expiry date of the Voucher", "format": "date-time", "nullable": true }, "externalIds": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumExternalId" }, "description": "External IDs", "nullable": true } }, "additionalProperties": false, "description": "Vouchers" }, "OmniumVoucherOmniumResult": { "type": "object", "properties": { "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVoucher" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic query result" }, "OmniumVoucherOmniumSearchResult": { "type": "object", "properties": { "facets": { "maxLength": 250, "type": "array", "items": { "$ref": "#/components/schemas/OmniumFacetViewModel" }, "description": "Search result facets", "nullable": true }, "totalHits": { "type": "integer", "description": "Total number of hits", "format": "int64" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVoucher" }, "description": "Search results", "nullable": true }, "scrollId": { "type": "string", "description": "The Scroll ID is used when fetching large amounts of data.\r\nWhenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents", "nullable": true }, "isValid": { "type": "boolean", "description": "Deprecated" } }, "additionalProperties": false, "description": "Generic class for receiving search results with facets" }, "OmniumVoucherSearchRequest": { "type": "object", "properties": { "take": { "type": "integer", "description": "Paged search - max number of invoices to return", "format": "int32" }, "page": { "type": "integer", "description": "Paged search - page", "format": "int32" }, "customerIds": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search Vouchers by customerIds", "nullable": true }, "statuses": { "maxLength": 250, "type": "array", "items": { "type": "string" }, "description": "Search Vouchers by statuses [Available, Applied, Redeemed, Expired]", "nullable": true }, "sortOrder": { "type": "string", "description": "Sort result. Available options [CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, ExpiryDateAscending, ExpiryDateDescending]", "nullable": true } }, "additionalProperties": false }, "OmniumWarehouseInventory": { "type": "object", "properties": { "entryId": { "type": "string", "description": "Unique identificaton", "nullable": true }, "warehouseCode": { "type": "string", "description": "Warehouse code", "nullable": true }, "inStockQuantity": { "type": "number", "description": "Number of items in stock", "format": "decimal" }, "reservedQuantity": { "type": "number", "description": "Number of items reserved", "format": "decimal" }, "reorderMinQuantity": { "type": "number", "description": "Minimum number of items to order", "format": "decimal" }, "preorderQuantity": { "type": "number", "description": "Preorder quantity", "format": "decimal" }, "backorderQuantity": { "type": "number", "description": "Backorder quantity", "format": "decimal" }, "allowBackorder": { "type": "boolean", "description": "True if backorder is allowed" }, "allowPreorder": { "type": "boolean", "description": "True of preorder is allowed" }, "inventoryStatus": { "type": "string", "description": "Inventory status", "nullable": true }, "preorderAvailabilityDate": { "type": "string", "description": "Date preorder is available", "format": "date-time", "nullable": true }, "backorderAvailabilityDate": { "type": "string", "description": "Date backorder is available", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "" }, "OmniumWorkflowStep": { "type": "object", "properties": { "name": { "type": "string", "description": "Workflow step name", "nullable": true }, "active": { "type": "boolean", "description": "True if step should be run" }, "runAfterOrderIsSaved": { "type": "boolean", "description": "True if step should run after order is saved" }, "stopOnError": { "type": "boolean", "description": "If true, the workflow will continue if current step fails to execute" }, "translateKey": { "type": "string", "description": "Translation key for workflow step name", "nullable": true }, "connector": { "type": "string", "description": "Connector to use for workflow step", "nullable": true }, "isInvisible": { "type": "boolean", "description": "True if result should not be shown in GUI" }, "enabledForMarkets": { "type": "array", "items": { "type": "string" }, "description": "List of markets where this workflow step should be enabled (all markets available if empty)", "nullable": true }, "disabledForMarkets": { "type": "array", "items": { "type": "string" }, "description": "List of market IDs where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForStores": { "type": "array", "items": { "type": "string" }, "description": "List of storeIds where this workflow step should be enabled (all stores available if empty)", "nullable": true }, "disabledForStores": { "type": "array", "items": { "type": "string" }, "description": "List of storeIds where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForStoreGroups": { "type": "array", "items": { "type": "string" }, "description": "List of store group IDs where this workflow step should be enabled (all store groups available if empty)", "nullable": true }, "disabledForStoreGroups": { "type": "array", "items": { "type": "string" }, "description": "List of store group IDs where the workflow step should be disabled (overrides enabled property)", "nullable": true }, "enabledForTags": { "type": "array", "items": { "type": "string" }, "description": "List of order tags where the workflow step should be disabled (available if empty)", "nullable": true }, "disabledForTags": { "type": "array", "items": { "type": "string" }, "description": "List of order tags where the workflow step should be disabled (ovverides enabled property)", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPropertyItem" }, "description": "Workflow step properties", "nullable": true } }, "additionalProperties": false }, "OmniumWorkflowStepRequest": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project ID", "nullable": true }, "date": { "type": "string", "description": "Date", "format": "date-time", "nullable": true }, "updateType": { "type": "string", "description": "Next or previous or specific step", "nullable": true }, "workflowStepId": { "type": "string", "description": "Specific step", "nullable": true }, "comment": { "type": "string", "description": "Workflow step comment", "nullable": true }, "partnerId": { "type": "string", "description": "Partner ID sending request", "nullable": true }, "partnerName": { "type": "string", "description": "Partner name sending the request", "nullable": true }, "userId": { "type": "string", "description": "User id sending the request", "nullable": true }, "userName": { "type": "string", "description": "User name sending the request", "nullable": true }, "data": { "type": "string", "description": "", "nullable": true } }, "additionalProperties": false, "description": "Workflow step response" }, "OmniumZipCodeRange": { "type": "object", "properties": { "zipCodeFrom": { "type": "string", "description": "Zip code range start (including this)", "nullable": true }, "zipCodeTo": { "type": "string", "description": "Zip codes range end (including this)", "nullable": true }, "marketId": { "type": "string", "description": "Market availability", "nullable": true } }, "additionalProperties": false, "description": "Class representing an interval of zip codes" }, "OmniumZReport": { "type": "object", "properties": { "zreportId": { "type": "string", "description": "Unique identifier for this Z-Report.", "nullable": true }, "companyName": { "type": "string", "description": "Name of the company operating the store.", "nullable": true }, "storeId": { "type": "string", "description": "Unique identifier of the store where this report was generated.", "nullable": true }, "storeName": { "type": "string", "description": "Name of the store where this report was generated.", "nullable": true }, "registerId": { "type": "string", "description": "Unique identifier of the register (cash register/POS terminal) that generated this report.", "nullable": true }, "dateCreated": { "type": "string", "description": "Date and time when the Z-Report was created/generated.", "format": "date-time" }, "vatNumber": { "type": "string", "description": "VAT registration number or company identifier used for tax purposes.", "nullable": true }, "user": { "type": "string", "description": "Name of the staff member who operated the register or generated this report.", "nullable": true }, "address": { "$ref": "#/components/schemas/OmniumAddress" }, "currencyCode": { "type": "string", "description": "Primary currency code for this register (ISO 4217 three-letter code, e.g., \"USD\", \"EUR\", \"SEK\").", "nullable": true }, "comment": { "type": "string", "description": "Optional comment or notes entered by staff when closing the register.", "nullable": true }, "discountSales": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscountSale" }, "description": "Discounts applied to sales transactions during this register period.", "nullable": true }, "discountRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumDiscountRefund" }, "description": "Discounts applied to return/refund transactions during this register period.", "nullable": true }, "productGroupings": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductGroupings" }, "description": "Sales grouped by product category or product group.", "nullable": true }, "productGroupRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumProductGroupRefund" }, "description": "Refunds/returns grouped by product category or product group.", "nullable": true }, "vatGroups": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVatGroup" }, "description": "Sales grouped by VAT rate or tax code.", "nullable": true }, "vatGroupRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumVatGroupRefund" }, "description": "Refunds/returns grouped by VAT rate or tax code.", "nullable": true }, "receiptCount": { "type": "integer", "description": "Total number of receipts printed during this register period.", "format": "int32" }, "drawerOpenings": { "type": "integer", "description": "Number of times the cash drawer was manually opened (excluding automatic openings during transactions).", "format": "int32" }, "sales": { "$ref": "#/components/schemas/OmniumZReportTotal" }, "salesTotalNet": { "type": "number", "description": "The net sales amount (excluding VAT/tax).", "format": "decimal" }, "salesItemsCount": { "type": "integer", "description": "Total number of individual items sold (not transactions, but actual product units).", "format": "int32" }, "returns": { "$ref": "#/components/schemas/OmniumZReportTotal" }, "refundTotalNet": { "type": "number", "description": "The net refund amount (excluding VAT/tax).", "format": "decimal" }, "refundItemsCount": { "type": "integer", "description": "Total number of individual items refunded (not transactions, but actual product units).", "format": "int32" }, "grandZReportTotal": { "$ref": "#/components/schemas/OmniumZReportTotal" }, "grandTotalSales": { "type": "number", "description": "The total gross money value for all sales.", "format": "decimal" }, "grandTotalRefund": { "type": "number", "description": "The total gross money value for all refunds.", "format": "decimal" }, "roundOff": { "type": "number", "description": "Rounding adjustment applied to transactions (e.g., for cash payments that need rounding to nearest coin).", "format": "decimal" }, "summarySalesTax": { "type": "number", "description": "Total sales tax/VAT amount in the summary.", "format": "decimal" }, "summaryRoundOff": { "type": "number", "description": "Total rounding adjustments in the summary.", "format": "decimal" }, "summarySubtotal": { "type": "number", "description": "Subtotal amount before tax and rounding adjustments.", "format": "decimal" }, "salesTaxesSales": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "Detailed sales tax breakdown for sales transactions (format varies by POS system).", "nullable": true }, "salesTaxesRefund": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "description": "Detailed sales tax breakdown for refund transactions (format varies by POS system).", "nullable": true }, "currencyConversions": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumCurrencyConversions" }, "description": "Foreign currency conversion details for registers handling multiple currencies.", "nullable": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumZReportPayment" }, "description": "Payment methods used for sales transactions during this register period.", "nullable": true }, "paymentRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumPaymentRefund" }, "description": "Payment methods used for refund transactions during this register period.", "nullable": true }, "salesType": { "$ref": "#/components/schemas/OmniumSalesType" }, "practice": { "$ref": "#/components/schemas/OmniumPractice" }, "cashManagement": { "$ref": "#/components/schemas/OmniumCashManagement" } }, "additionalProperties": false, "description": "Represents a Z-Report, a financial summary report generated when closing a cash register or POS terminal.\r\nContains sales, returns, payment methods, and cash management information for a specific register period." }, "OmniumZReportFilter": { "type": "object", "properties": { "fromDate": { "type": "string", "format": "date-time" }, "toDate": { "type": "string", "format": "date-time" }, "marketIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "storeIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "storeGroupIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OmniumZReportPayment": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the payment method (e.g., \"Cash\", \"Credit Card\", \"Mobile Payment\").", "nullable": true }, "amount": { "type": "number", "description": "Total amount received through this payment method.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of transactions using this payment method.", "format": "int32" }, "subPayments": { "type": "array", "items": { "$ref": "#/components/schemas/OmniumSubPayment" }, "description": "Breakdown of this payment method into sub-categories (optional).", "nullable": true } }, "additionalProperties": false, "description": "Represents a payment method used for sales transactions." }, "OmniumZReportTotal": { "type": "object", "properties": { "amount": { "type": "number", "description": "Total monetary amount.", "format": "decimal" }, "count": { "type": "integer", "description": "Number of transactions contributing to this total.", "format": "int32" } }, "additionalProperties": false, "description": "Represents a total with amount and count (used for sales, returns, grand totals)." }, "GenerateSAFTReportRequest": { "type": "object", "properties": { "storeId": { "type": "string", "nullable": true }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "KitPromotionRewardType": { "enum": [ "Percentage", "Amount", "FixedPrice" ], "type": "string", "description": "Defines the type of reward [Percentage = 0, Fixed amount = 1, Fixed price = 2]" }, "LineItemIdMapping": { "type": "object", "properties": { "oldLineItemId": { "type": "string", "description": "The current/old line item ID to be replaced (Required)", "nullable": true }, "newLineItemId": { "type": "string", "description": "The new line item ID to replace with (Required)", "nullable": true } }, "additionalProperties": false, "description": "Mapping from old line item ID to new line item ID" }, "OrderLineReplacementRequestModel": { "required": [ "lineItemId", "quantity" ], "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Orderline id to replace" }, "quantity": { "type": "integer", "description": "Quantity to replace", "format": "int32" }, "replacementType": { "type": "string", "description": "Replacement type (Should correspond to predefined list of replacement types)", "nullable": true }, "replacementReason": { "type": "string", "description": "Replacement reason", "nullable": true }, "skuId": { "type": "string", "description": "You can add a SkuId of a product if you want to replace the current product on the orderline with a different product in the replacementOrder", "nullable": true } }, "additionalProperties": false, "description": "Orderline replacement request model" }, "PatchLineItemIdsDetails": { "type": "object", "properties": { "orderFormLineItemsUpdated": { "type": "integer", "description": "Number of line items updated in order.OrderForm.LineItems", "format": "int32" }, "shipmentLineItemsUpdated": { "type": "integer", "description": "Number of line items updated across all shipments", "format": "int32" }, "returnOrderFormLineItemsUpdated": { "type": "integer", "description": "Number of line items updated across all return order forms", "format": "int32" } }, "additionalProperties": false, "description": "Details of line item ID updates by location" }, "ProblemDetails": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": false } }, "PromotionType": { "enum": [ "ShippingPromotion", "CategoryOrBrandPromotion", "MultiBuyPromotion", "OrderAmountPromotion", "KitPromotion", "ProductSearchPromotion", "PriceListPromotion", "CostPricePromotion" ], "type": "string", "description": "Defines the type of promotion [ShippingPromotion = 0, CategoryOrBrandPromotion = 1, MultiBuyPromotion = 2, OrderAmountPromotion = 3, KitPromotion = 4, ProductSearchPromotion = 5, PriceListPromotion = 6, CostPricePromotion = 7]" }, "ShipmentPackageLineItemReference": { "type": "object", "properties": { "lineItemId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Used to add a link between packages and LineItems" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Tokens", "description": "Get JWT token for access to Omnium APIs.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Get", "description": "Endpoints for order getters.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Update", "description": "Main endpoints for order management.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Batch Updates", "description": "Endpoints for batch updates for orders.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Search", "description": "Search for orders.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Workflow", "description": "Order workflow processing.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=workflows" } }, { "name": "Orders | Order Lines", "description": "Order lines.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=order-lines" } }, { "name": "Orders | Shipments", "description": "Order shipments.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=shipments" } }, { "name": "Orders | Returns", "description": "Return processing.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Gift Cards", "description": "Gift cards", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Subscriptions", "description": "Subscriptions", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Invoices", "description": "Invoices", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Payments", "description": "Payments", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Click and Collect", "description": "Click and collect order type has some custom features in Omnium UI and API.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Pick Lists", "description": "Pick lists for warehouse movements.", "externalDocs": { "url": "https://docs.omnium.no/#/api/" } }, { "name": "Orders | Others", "description": "Various endpoints for order management.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Orders | Analytics", "description": "Order analytics endpoints.", "externalDocs": { "url": "https://docs.omnium.no/#/api/orders?id=orders" } }, { "name": "Insights", "description": "Aggregated daily KPIs for analytics partners." }, { "name": "Carts | Update", "description": "Contains endpoints for creating and modifying carts. Carts are orders that are not yet confirmed by customer. Inherits order model, but has additional properties.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Add", "description": "Contains endpoints for adding items to carts. Carts are orders that are not yet confirmed by customer. Inherits order model, but has additional properties.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Get", "description": "Contains endpoints for getting items to carts.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Search", "description": "Contains endpoints for searching for carts with different parameters. Carts are orders that are not yet confirmed by customer. Inherits order model, but has additional properties.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Checkout", "description": "Contains endpoints for the cart checkout process. Adding payment, customer, discounts, validating cart etc.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Line Items", "description": "Contains endpoints for updating cart orderLines. Carts are orders that are not yet confirmed by customer. Inherits order model, but has additional properties.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Carts | Other", "description": "Various endpoints for carts.", "externalDocs": { "url": "https://docs.omnium.no/#/api/carts?id=carts" } }, { "name": "Carts | Templates", "description": "Various endpoints for carts. Cart templates are typically used as an easy way to create multiple offers to customers in a B2B context, but can be used in other scenarios as well.", "externalDocs": { "url": "https://docs.omnium.no/#/api/carts?id=carts" } }, { "name": "Comments", "description": "Endpoints for managing comments. Only used for Project comments at the moment. For comments related to other objects comments should be added on the objects themselves or through dedicated endpoints." }, { "name": "Promotions", "description": "Discount and promotion API" }, { "name": "Promotions | Campaigns", "description": "Campaign management API for planning and grouping promotions" }, { "name": "Customers | B2B", "description": "Business customers are used for B2B commerce. Share many of the same properties as private customers.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | B2B | Assets", "description": "Manage assets on Business Customers.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | B2B | Contact persons", "description": "Manage contact persons on Business Customers.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | B2C", "description": "Private customers are used for B2C or D2C commerce.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | B2C | Versions", "description": "Fetch previous versions of private customers.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | Customer groups", "description": "Customers groups are used to organize groups of customers and assign prices and promotions to groups of customers.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Customers | B2C | Privacy", "description": "Endpoints for ensuring privacy and GDPR compliance.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Cases", "description": "Customer cases and support tickets." }, { "name": "Products", "description": "Product information and enrichment.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=products" } }, { "name": "Products | Variants", "description": "Product variant information.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=products" } }, { "name": "Products | Categories", "description": "Product category information.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=products" } }, { "name": "Products | Inventory", "description": "Fetch and update inventory.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Prices", "description": "Fetch and update product prices.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Alerts", "description": "Product alerts.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Price Lists", "description": "Product price list information.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=products" } }, { "name": "Products | Price List Items", "description": "Product price list items.", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=products" } }, { "name": "Products | Recommendations", "description": "Product recommendations.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Query (Preview)", "description": "🧪 **Preview** — early access! These endpoints are fully functional, but their shape may still change while we finalize them. Query products.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Search", "description": "Search for products.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Batch Updates", "description": "Batch updates for products.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Get", "description": "Get products by parameters.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Update", "description": "Update products.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Assets", "description": "Product assets.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Products | Cost Prices", "description": "Product cost prices." }, { "name": "Products | Rentals", "description": "Product Rentals." }, { "name": "Notifications", "description": "Send e-mail or SMS through Omnium.", "externalDocs": { "url": "https://docs.omnium.no/#/api/markets?id=markets" } }, { "name": "Stores", "description": "Warehouses, stores, and other sales channels.", "externalDocs": { "url": "https://docs.omnium.no/#/api/markets?id=markets" } }, { "name": "Date Planners", "description": "Date planners.", "externalDocs": { "url": "https://docs.omnium.no/#/api/stores?id=stores" } }, { "name": "Markets", "description": "Markets in Omnium are used for configuring currencies, languages, available connectors, etc for different countries, concepts, ownerships or a combination of the above.", "externalDocs": { "url": "https://docs.omnium.no/#/api/markets?id=markets" } }, { "name": "Assets | Files", "description": "File operations.", "externalDocs": { "url": "https://docs.omnium.no/#/api/markets?id=markets" } }, { "name": "Assets | Images", "description": "Image operations.", "externalDocs": { "url": "https://docs.omnium.no/#/api/markets?id=markets" } }, { "name": "Invoices", "description": "Invoices", "externalDocs": { "url": "https://docs.omnium.no/#/api/" } }, { "name": "Vouchers", "description": "Vouchers", "externalDocs": { "url": "https://docs.omnium.no/#/api/" } }, { "name": "Ratings", "description": "Add or get ratings.", "externalDocs": { "url": "https://docs.omnium.no/#/api/inventory?id=inventory" } }, { "name": "Projects", "description": "Projects", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Project types", "description": "Project types", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Assets", "description": "Project assets", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Parts", "description": "Project parts", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Change orders", "description": "Project change orders", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Transactions", "description": "Project transactions", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Versions", "description": "Project versioning", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Time entries", "description": "Project time entries", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Logs", "description": "Project logs", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Projects | Reports", "description": "Project reports", "externalDocs": { "url": "https://docs.omnium.no/#/api/products?id=product" } }, { "name": "Suppliers", "description": "Suppliers" }, { "name": "Purchase Orders", "description": "Purchase orders" }, { "name": "Purchase Orders | Workflows", "description": "Purchase order workflows" }, { "name": "Purchase Orders | Deliveries", "description": "Deliveries" }, { "name": "Users", "description": "Administrate users and roles" }, { "name": "Event Log", "description": "Event log endpoints" }, { "name": "Triggers", "description": "Trigger actions" }, { "name": "Obsolete", "description": "Obsolete endpoints" }, { "name": "Health", "description": "Check health of Omnium API. Will return 200 when Omnium services are healthy ❤" }, { "name": "Settings", "description": "Settings" }, { "name": "Settings | Products", "description": "Product related tenant settings" }, { "name": "Settings | Property Options", "description": "Property options for products, customers, and other entities" } ] }