Compare commits
No commits in common. "1c7255fa725b946ce3831014dc7fd0191a701569" and "dacc6cade4fadc0b7aaf26eedd4a9364382702f2" have entirely different histories.
1c7255fa72
...
dacc6cade4
290
src/v2/shop.yaml
290
src/v2/shop.yaml
|
|
@ -1,7 +1,7 @@
|
||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: "TyrePro-API, Shop"
|
title: "TyrePro-API, Shop"
|
||||||
version: "Version 13"
|
version: "Version 12"
|
||||||
servers:
|
servers:
|
||||||
- url: "https://musterreifen.com/api/shop"
|
- url: "https://musterreifen.com/api/shop"
|
||||||
description: "Development server, customers domain"
|
description: "Development server, customers domain"
|
||||||
|
|
@ -71,9 +71,29 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- "General"
|
- "General"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidCart"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
in: "query"
|
||||||
- $ref: "#/components/parameters/GuidCart"
|
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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -143,9 +163,29 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- "General"
|
- "General"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidCart"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
in: "query"
|
||||||
- $ref: "#/components/parameters/GuidCart"
|
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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -453,7 +493,6 @@ paths:
|
||||||
- $ref: "#/components/parameters/GuidOffset"
|
- $ref: "#/components/parameters/GuidOffset"
|
||||||
- $ref: "#/components/parameters/GuidHubBoreHole"
|
- $ref: "#/components/parameters/GuidHubBoreHole"
|
||||||
- $ref: "#/components/parameters/GuidManufacturer"
|
- $ref: "#/components/parameters/GuidManufacturer"
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
|
||||||
- name: "Type"
|
- name: "Type"
|
||||||
description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
|
description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
|
||||||
in: "query"
|
in: "query"
|
||||||
|
|
@ -475,6 +514,14 @@ paths:
|
||||||
- "Offset"
|
- "Offset"
|
||||||
- "HubBoreHole"
|
- "HubBoreHole"
|
||||||
- "Manufacturer"
|
- "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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -547,9 +594,22 @@ paths:
|
||||||
- $ref: "#/components/parameters/GuidManufacturer"
|
- $ref: "#/components/parameters/GuidManufacturer"
|
||||||
- $ref: "#/components/parameters/BinaryObjectContentType"
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
- $ref: "#/components/parameters/GuidDeliveryType"
|
- $ref: "#/components/parameters/GuidDeliveryType"
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidBranch"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
description: "Required for providing stock and price information."
|
||||||
- $ref: "#/components/parameters/GuidShopArticleConfig"
|
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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -568,6 +628,33 @@ paths:
|
||||||
$ref: "#/components/responses/GenericError"
|
$ref: "#/components/responses/GenericError"
|
||||||
security:
|
security:
|
||||||
- SessionScheme: []
|
- 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:
|
/ShopArticlePairs:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
|
@ -589,9 +676,22 @@ paths:
|
||||||
- $ref: "#/components/parameters/GuidManufacturer"
|
- $ref: "#/components/parameters/GuidManufacturer"
|
||||||
- $ref: "#/components/parameters/BinaryObjectContentType"
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
- $ref: "#/components/parameters/GuidDeliveryType"
|
- $ref: "#/components/parameters/GuidDeliveryType"
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidBranch"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
description: "Required for providing stock and price information."
|
||||||
- $ref: "#/components/parameters/GuidShopArticleConfig"
|
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"
|
- name: "SearchTerm2"
|
||||||
in: "query"
|
in: "query"
|
||||||
required: false
|
required: false
|
||||||
|
|
@ -660,74 +760,23 @@ paths:
|
||||||
$ref: "#/components/responses/GenericError"
|
$ref: "#/components/responses/GenericError"
|
||||||
security:
|
security:
|
||||||
- SessionScheme: []
|
- 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:
|
/ShopArticleStockDetails:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- "ArticleDetails"
|
- "Search"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidOnlineService"
|
- $ref: "#/components/parameters/GuidOnlineService"
|
||||||
- $ref: "#/components/parameters/GuidDeliveryType"
|
- $ref: "#/components/parameters/GuidDeliveryType"
|
||||||
- $ref: "#/components/parameters/GuidShopArticle"
|
- name: "GuidShopArticle"
|
||||||
- $ref: "#/components/parameters/GuidShopArticleConfig"
|
in: "query"
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: "string"
|
||||||
|
default: null
|
||||||
|
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
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:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -1004,8 +1053,22 @@ paths:
|
||||||
- "Cart"
|
- "Cart"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidOnlineService"
|
- $ref: "#/components/parameters/GuidOnlineService"
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidBranch"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -1124,9 +1187,29 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- "Cart"
|
- "Cart"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidBranch"
|
- name: "GuidCart"
|
||||||
- $ref: "#/components/parameters/GuidCalculationProfile"
|
in: "query"
|
||||||
- $ref: "#/components/parameters/GuidCart"
|
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:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -1144,7 +1227,13 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- "Cart"
|
- "Cart"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidCart"
|
- name: "GuidCart"
|
||||||
|
in: "query"
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: "string"
|
||||||
|
default: null
|
||||||
|
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|
@ -2194,48 +2283,6 @@ components:
|
||||||
type: "string"
|
type: "string"
|
||||||
default: null
|
default: null
|
||||||
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
|
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:
|
SearchTerm:
|
||||||
name: "SearchTerm"
|
name: "SearchTerm"
|
||||||
in: "query"
|
in: "query"
|
||||||
|
|
@ -2267,6 +2314,7 @@ components:
|
||||||
|
|
||||||
# MISSING
|
# MISSING
|
||||||
# GET /Vehicles
|
# GET /Vehicles
|
||||||
|
# GET /Tubes
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue