New Endpoint for StockDetails of an article

And some more descriptions for stock coloumns. The clients are using often abbreviations
This commit is contained in:
Nico Kroll 2025-10-15 11:17:18 +02:00
parent 1edeb5178d
commit 6d93e58c98
1 changed files with 65 additions and 14 deletions

View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, Shop" title: "TyrePro-API, Shop"
version: "Version 10" version: "Version 11"
servers: servers:
- url: "https://musterreifen.com/api/shop" - url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain" description: "Development server, customers domain"
@ -511,6 +511,7 @@ paths:
- $ref: "#/components/parameters/GuidHubBoreHole" - $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer" - $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/BinaryObjectContentType" - $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType"
- name: "GuidBranch" - name: "GuidBranch"
description: "Required for providing stock and price information." description: "Required for providing stock and price information."
in: "query" in: "query"
@ -519,14 +520,6 @@ paths:
type: "string" type: "string"
default: null default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164" example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidDeliveryType"
description: "For providing more accurate stock and price information."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile" - name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile." description: "If provided, the prices will base on this profile."
in: "query" in: "query"
@ -580,6 +573,33 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
/ShopArticleStockDetails:
get:
tags:
- "Search"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidDeliveryType"
- name: "GuidShopArticle"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticleStockDetail"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
# Calculation # Calculation
/CalculationProfiles: /CalculationProfiles:
get: get:
@ -1348,13 +1368,19 @@ components:
items: items:
type: "object" type: "object"
required: required:
- "Designation"
- "FieldName" - "FieldName"
- "Abbreviation"
- "Designation"
- "DataType" - "DataType"
- "StockDetailsAreAvailable"
properties: properties:
FieldName:
type: "string"
Abbreviation:
type: "string"
Designation: Designation:
type: "string" type: "string"
FieldName: Description:
type: "string" type: "string"
DataType: DataType:
type: "string" type: "string"
@ -1366,6 +1392,8 @@ components:
- "date" - "date"
- "dateTime" - "dateTime"
- "stock" - "stock"
StockDetailsAreAvailable:
type: "boolean"
Module: Module:
type: "object" type: "object"
required: required:
@ -1507,14 +1535,11 @@ components:
required: required:
- "FieldName" - "FieldName"
- "Amount" - "Amount"
- "StockType"
properties: properties:
FieldName: FieldName:
type: "string" type: "string"
Amount: Amount:
type: "number" type: "number"
StockType:
type: "string"
DeliveryDate: DeliveryDate:
type: "string" type: "string"
format: "date" format: "date"
@ -1569,6 +1594,24 @@ components:
type: "string" type: "string"
File: File:
$ref: "#/components/schemas/DbBlob" $ref: "#/components/schemas/DbBlob"
ShopArticleStockDetail:
type: "object"
required:
- "FieldName"
- "Designation"
- "Amount"
properties:
FieldName:
type: "string"
Designation:
type: "string"
GuidBranch:
type: "string"
Amount:
type: "number"
DeliveryDate:
type: "string"
format: "date"
MaterialType: MaterialType:
type: "object" type: "object"
required: required:
@ -2020,6 +2063,14 @@ components:
type: "string" type: "string"
default: null default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164" example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidDeliveryType:
description: "For providing more accurate stock and price information."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMaterialType: GuidMaterialType:
name: "GuidMaterialType" name: "GuidMaterialType"
in: "query" in: "query"