PRM_Software_AG
/
api-documentation
12
1
Fork 0
Code Issues 10 Pull Requests Activity

Compare commits

base: PRM_Software_AG:1c7255fa725b946ce3831014dc7fd0191a701569
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development
..
compare: PRM_Software_AG:dacc6cade4fadc0b7aaf26eedd4a9364382702f2
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development

No commits in common. "1c7255fa725b946ce3831014dc7fd0191a701569" and "dacc6cade4fadc0b7aaf26eedd4a9364382702f2" have entirely different histories.
1c7255fa72 ... dacc6cade4

1 changed files with 169 additions and 121 deletions
Show Stats Expand all files Collapse all files

290
src/v2/shop.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: "TyrePro-API, Shop"
version: "Version 13"
version: "Version 12"
servers:
- url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain"
@ -71,9 +71,29 @@ paths:
tags:
- "General"
parameters:
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidCart"
- name: "GuidCart"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -143,9 +163,29 @@ paths:
tags:
- "General"
parameters:
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidCart"
- name: "GuidCart"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -453,7 +493,6 @@ paths:
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidBranch"
- name: "Type"
description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
in: "query"
@ -475,6 +514,14 @@ paths:
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -547,9 +594,22 @@ paths:
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidShopArticleConfig"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -568,6 +628,33 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticleInformations:
get:
tags:
- "Search"
parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidOnlineService"
- 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/ShopArticleInformation"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticlePairs:
get:
tags:
@ -589,9 +676,22 @@ paths:
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidShopArticleConfig"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "SearchTerm2"
in: "query"
required: false
@ -660,74 +760,23 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
# ArticleDetails
/ShopArticleAccessories:
get:
tags:
- "ArticleDetails"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidShopArticle"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidShopArticleConfig"
responses:
200:
description: "successful operation"
headers:
Guid-Shop-Article-Config:
schema:
type: "string"
description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticle"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticleInformations:
get:
tags:
- "ArticleDetails"
parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidShopArticle"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticleInformation"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticleStockDetails:
get:
tags:
- "ArticleDetails"
- "Search"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidShopArticle"
- $ref: "#/components/parameters/GuidShopArticleConfig"
- name: "GuidShopArticle"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
headers:
Guid-Shop-Article-Config:
schema:
type: "string"
description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
content:
application/json:
schema:
@ -1004,8 +1053,22 @@ paths:
- "Cart"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -1124,9 +1187,29 @@ paths:
tags:
- "Cart"
parameters:
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidCart"
- name: "GuidCart"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
- name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
responses:
200:
description: "successful operation"
@ -1144,7 +1227,13 @@ paths:
tags:
- "Cart"
parameters:
- $ref: "#/components/parameters/GuidCart"
- name: "GuidCart"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
requestBody:
required: true
content:
@ -2194,48 +2283,6 @@ components:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidBranch:
name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidCalculationProfile:
name: "GuidCalculationProfile"
description: "If provided, the prices will base on this profile."
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidCart:
name: "GuidCart"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidShopArticle:
name: "GuidShopArticle"
in: "query"
required: true
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidShopArticleConfig:
name: "GuidShopArticleConfig"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
SearchTerm:
name: "SearchTerm"
in: "query"
@ -2267,6 +2314,7 @@ components:
# MISSING
# GET /Vehicles
# GET /Tubes