Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API for retrieving product data.

Endpoint: productApi/

...

v1/products

Method: GET

Summary: Provides product data to buyers. The buyer GLN is determined based on the username

...

  • PDINumber (query): PDI number
  • SellerVPN (query): Manufacturer Part Number
  • GTIN (query): GTIN
  • Quantity (query): Quantity for which you want the price and availability
  • BidID (query): Contract ID for the price of a contract product
  • SellerGLN (query): Seller GLN
  • RealTime (query): Real time

Responses:

  • 200 :

Endpoint: productApi/

...

v1/products/bulk

Method: POST

Summary: Get multiple products

...

  • 200 : success
  • 204 : no items were found
  • 207 : success
  • 400 : bad request
  • 401 : user not authorized
  • 500 : internal server error
  • 501 : not supported yet

Endpoint: productApi/

...

v1/products/index

Method: GET

Summary: Get product index

...

  • onlyModified (query): Return only modified products, Currently only value 'true' is supported.
  • onlySubscribed (query): Return only subscribed products. Currently only value 'true' is supported. 
  • SellerGLN (query): Return only products from a particular seller.

...

  • 200 : success
  • 204 : no items were found
  • 400 : bad request
  • 401 : user not authorized
  • 500 : internal server error
  • 501 : not supported yet

Endpoint: productApi

...

/v1/products/buyer/{BuyerGLN}/seller/{SellerGLN}/pdi/{PDINumber}

Method: GET

Summary: An internal endpoint used for fetching product data by the Product Guide

...

  • BuyerGLN (path): Buyer GLN
  • SellerGLN (path): Seller GLN
  • PDINumber (path): PDI number

Responses:

  • 200 :

Endpoint: productApi/rest/internal/v1/healthCheck

Method: GET

Summary: Get full internal health check

Operation ID: route15

Responses:

  • 200 :

Endpoint: productApi

...

/v1/healthCheck

Method: GET

Summary: Get limited customer health check

Operation ID: route17

Responses:

  • 200 :

Endpoint: productApi

...

/v1/ping

Method: GET

Summary: Ping endpoint

Operation ID: route18

Responses:

  • 200 :

Downloads

Please find below the OpenApi definition for Product Now.

...