BSRO For Store Output (v 1.2.1)

Owned by Oleksandr Samarin
Dec 12, 2019
5 min read

OVERVIEW

Output REST. API to get exclude list by request.

#Api methodurldescription
1vehType suppressionapi/for_store/suppression/by_store/{type}Show all excluded displayIds for vehtype
2Store number suppressionapi/for_store/suppression/by_store/{id}Show all excluded articles for storage
3Websourceapi/for_store/websource/{websource}Show all available articles for websource
Proxy methods
4Search by Size(new)api/for_store/search/by_sizeShow tires, that available in catalog, search by size, with filtered data;Using store and vehtype, websource  filters
5Search by model and brand/api/for_store/search/by_brand/{brand}/{model}Show tires, that available in catalog, by brand and number. Using websource  filters
6Search by vehicle/api/for_store/search/by-vehicleShow tires, that available in catalog, by vehicle. Using store and vehtype, websource  filters
7Search Tires by Category/api/for_store/tire/category/{category}To get the tire catalog details. Used websource, store filters
8Search Size Rims List/api/for_store/size/reverseTo retrieve the entire distinct vehicle rim diameter values.use websource
9Search Size Cross and Aspect List By Rim/api/for_store/size/reverse/{rim}To retrieve the entire distinct tire sizes for the given vehicle rim diameter value by size.used webstore  and vehtype

Size dictionary will help to know actual sizes from database; it returns known sizes linked one to other.

Search returns known tires, used brands & part numbers.

Search by size returns size id & founded tires.

METHODS DESCRIPTION

1. vehType Suppression

Explanation:

Show all excluded displayIds for vehType.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/suppression/by_vehtype/{type}

EG. https://bsro.tireconnect.ca/api/for_store/suppression/by_vehtype/VAN

Request Parameters

Parameter(s)
example value and explanation if needed
Required
typevan(VAN,MVAN,TRK,SUV)YES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "suppressionVehicle": {
      "vehType": "van",
      "displayIds": [
        "88955"
      ],
      "articles": [
        "1372",
        "1373",
        "1374",
        "1375",
        "1376",
        "3230",
        "3232",
        "3233",
        "11442",
        "11459",
        "11476",
        "11510",
        "11527",
        "11561",
        "11578",
        "11612",
        "11629",
        "11646",
        "11663",
        "11680",
        "11748",
        "11765",
        "11782",
        "11799",
        "11816",
        "11833",
        "11850",
        "11867",
        "11901",
        "11918",
        "17800",
        "19687",
        "19721",
        "19738",
        "19772",
        "19789"
      ]
    }
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
suppressionVehicleroot.payload.suppressionVehicleNODE
vehTyperoot.payload.suppressionVehicle[].vehTypeRequested vehType
displayIdsroot.payload.suppressionVehicle[].displayIdsDisplsplayId values that will be suppressed
articlesroot.payload.suppressionVehicle[].articlesList of restricted articles of tires

Note:

 All data actual according to BSRO-catalogue and  TP_SUPRESSION_PRODUCT_VEHTYPE source table.

Exception:

if nothing found : 404 error.


2. Store number suppression

Explanation:

Show all excluded articles for selected store.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/suppression/by_store/{id}

EG. https://bsro.tireconnect.ca/api/for_store/suppression/by_store/26824

Request Parameters

Parameter(s)
example value and explanation if needed
Required
storeNumber26824 (any valid store number)YES
Output 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "suppressionStore": {
      "storeNumber": "26824",
      "displayIds": [
        "77268",
        "85386"
      ],
      "articles": [
        "7091878",
        "7091879",
        "7091880",
        "7091881",
        "7091882",
        "7091883",
        "7091884",
        "7091885"
      ]
    }
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
suppressionStoreroot.payload.suppressionStoreNODE
storeNumberroot.payload.suppressionStore[].storeNumberStore Number
displayIdsroot.payload.suppressionStore[].displayIds
NODE
displayIds[]root.payload.suppressionStore[].displayIds[]DisplsplayId values that will be suppressed
articlesroot.payload.suppressionStore.articles[]List of articles, that restricted for this websource

Note:

Use logic from business logic document 2.3.13.

Used tables: 

TP_SUPPRESSION_PBID_SKU

RTMS_WEBDB.TP_STORE_LIST

TP_SUPPRESSION_PBID_SKU.CSV

Exception:

if nothing found : 404 error.

3. Websource

Explanation:

Show all available articles for websource.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/websource/{websource}

EG. https://bsro.tireconnect.ca/api/for_store/websource/FCAC

Request Parameters

Parameter(s)
example value and explanation if needed
Required
websourceFCAC(FCAC, HT, TP, WWT)YES
Output(trimmed) 
{
  "statusCode": "SUCCESSFUL",
  "payload": {
    "websource": {
      "websourceName": "FCAC",
      "articles": [
        "9",
        "10",
        "11",
        "107",
        "168",
        "172",
        "173",
        "174",
        "175",
        "176",
        "177",
        "200",
        "214",
        "215",
        "216",
        "223",
        ......
      ]
    }
  }
}

Output description

valuepathcomment
statusCoderoot.statusCode=SUCCESSFUL
payloadroot.payloadNODE
websourceroot.payload.websourceNODE
websourceNameroot.payload.websource.websourceNameWebsource name
articlesroot.payload.websource.articles[]List of articles, that available for this websource

Note:

Websource filter, show only permitted articles for correspondent websource.


Exception:

if nothing found : 404 error.

4. Search by Size(new)

Explanation:

Show tires that available in catalog, search by size with filtered data. Using store  and websource filters.

Action: GET

URL: https://bsro.tireconnect.ca/api/search/by_size?cross=195&aspect=65&rim=15&websource={websource}&storeNumber={storeNumber}

EG. https://bsro.tireconnect.ca/api/for_store/search/by_size?cross=195&aspect=65&rim=15&websource=FCAC&storeNumber=23817

Request Parameters

Parameter(s)
example value and explanation if needed
Required
cross225 (Cross Section). Optional input if acesVehicleId is passedYES
aspect65 (Aspect Ratio). Optional input if acesVehicleId is passedYES
rim16 (Rim Diameter). Optional input if acesVehicleId is passedYES
storeNumber23817 (valid store number from RTMS_WEBDB.STORE table)YES
websourceFCAC (FCAC, TP, HT, WWT)YES

Output

Equal to #8 method BSRO Catalog REST API filtered by websource and storeNumber

Output description

valuepathcomment
storeNumberroot.payload.storeNumberRequested storeNumber

Note:

vehicleId or cross and aspect and rim must be in request

Exception:

if nothing found for selected store & websource : 404 error.

5. Search by model and brand

Explanation:

Show tires, that available in catalog, by brand and number. Using websource filters.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/search/by_brand/{brand}/{model}?websource={websource}

EG. https://bsro.tireconnect.ca/api/for_store/search/by_brand/Firestone/AffinityTouring?websource=FCAC

Request Parameters

Parameter(s)
example value and explanation if needed
Required
brandFirestoneYES
tireNameDestinationLE2YES
websourceFCAC(any valid site name FCAC, TP, HT, WWT)YES

Output

Equal to #10 method BSRO Catalog REST API filtered by websource.

Exception:

if nothing found for selected store: 404 error.

6. Search by vehicle

Explanation:

Show tires that available in catalog by acesVehicleId. Using store, vehtype, websource filters.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/search/by-vehicle?acesVehicleId={acesVehicleId}&websource={websource}&storeNumber={storeNumber}

EG. https://bsro.tireconnect.ca/api/for_store/search/by-vehicle?acesVehicleId=143886&websource=FCAC&storeNumber=23817

Request Parameters

Parameter(s)
example value and explanation if needed
Required
acesVehicleId143886. Optional input if cross/aspect/rim is passedYES
storeNumber23817 (valid store number from RTMS_WEBDB.STORE table)YES
websourceFCAC(any valid site name FCAC, TP, HT, WWT)YES

Output

Equal to #9 method BSRO Catalog REST API filtered by websource and storeNumber.

Output description

Field name(required data)pathcomment
storeNumberroot.payload.storeNumberRequested storeNumber
Rest data equal to correspondent method of vehicle search from bsro API

Exception:

if nothing found for selected store & websource: 404 error.

7. Search Tires by Category

Explanation:

To get the tire catalog details using websource and store filters.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/tire/category/{category}/{websource}

EG. https://bsro.tireconnect.ca/api/for_store/tire/category/winter/FCAC

Request Parameters

Parameter(s)
example value and explanation if needed
Required
categorylight-truck (Any valid categories from {all-tires, winter, light-truck, performance, suv-cuv, car-minivan})YES
websourceFCAC(any valid site name FCAC, TP, HT, WWT)YES

Output

Equal to #19 method BSRO Catalog REST API filtered by websource.

Exception:

if nothing found for selected websource: 404 error.

8. Search Size Rims List

Explanation:

To retrieve the entire distinct vehicle rim diameter values with using websource filtering.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/size/reverse/{websource}

EG. https://bsro.tireconnect.ca/api/for_store/size/reverse/FCAC

Request Parameters

Parameter(s)
example value and explanation if needed
Required
websourceFCAC(any valid site name FCAC, TP, HT, WWT)YES

Output

Equal to #16 method BSRO Catalog REST API filtered by websource.

Exception:

if nothing found for selected websource: 404 error.

9. Search Size Cross and Aspect List By Rim

Explanation:

To retrieve the entire distinct tire sizes for the given vehicle rim diameter value by size used webstore and vehtype.

Action: GET

URL: https://bsro.tireconnect.ca/api/for_store/size/reverse/{rim}/{websource}

EG. https://bsro.tireconnect.ca/api/for_store/size/reverse/15/FCAC

Request Parameters

Parameter(s)
example value and explanation if needed
Required
rim16YES
websourceFCAC(any valid site name FCAC, TP, HT, WWT)YES

Output

Equal to #17 method BSRO Catalog REST API filtered by websource.

Exception:

if nothing found for selected websource: 404 error.