...

• RESTful services have a smaller footprint than SOAP, Parsing JSON is less computationally heavy and memory intensive then XML, however we can still support XML as well.
• Improved efficiency allows us to support bulk requests as well as single requests, this will allow buyers to retrieve multiple items with 1 request rather than multiple single requests.
• The health check will allow you to monitor the availability and uptime of the service.
• On daily bases you can retrieve a list of changed products and via the bulk request, retrieve the updated products.

Syntax

https://$base_url?{SellerGLN}&{PDINumber}&{SellerVPN}&{GTIN}&{Quantity}&{BidID}

• The API supports basic authentication only, for this you need a service user created in TPN Manager.

Syntax

ProductAPI - v1

API for retrieving product data.

Endpoint: productApi/rest/public

...

/v1/products

...

Method: GET

...

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

Operation ID: route7

Parameters:

• 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/rest/public

...

/v1/products/bulk

Method: POST

Summary: Get multiple products

Operation ID: route9

Parameters:

• body (body)

...

Uses basic authentication and user managed in the TPN Manager.

• : List of requested items

Responses:

• 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/rest/public/v1/products/index

Method: GET

Summary: Get product index

Operation ID: route11

Parameters:

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

Responses:

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

Endpoint: productApi/rest/internal/v1/products/buyer/{BuyerGLN}/seller/{SellerGLN}/pdi/{PDINumber}

Method: GET

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

Operation ID: route13

Parameters:

• 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/rest/public/v1/healthCheck

Method: GET

Summary: Get limited customer health check

Operation ID: route17

Responses:

• 200 :

Endpoint: productApi/rest/public/v1/ping

Method: GET

Summary: Ping endpoint

Operation ID: route18

Responses:

• 200 :

...

• For retrieving the list of changed products or single product request, the GET request type is used.

• For retrieving a list of products (bulk) the POST request type is used.

• Response:
  • If no Seller GLN is specified, the response will contain all products from Sellers that matches the Request of which the buyer has prices

• Remarks:
  • The JSON response is based on the PRD version 3.1 output
  • The result can contain multiple Onetrail PDI items. In that case the response will contain n-times an ns2:product element
  • The result can contain multiple Seller items per Onetrail PDI item. In that case the response will contain n-time an ns2:sellerInfo element

...

• application/json
• application/xml

Authentication:

...

Downloads

Please find below the OpenApi definition for Product Now.

...