Price

The Get Price API is a newly introduced API that offers a streamlined way to obtain product prices and additional related information. This API empowers users to retrieve pricing details and more, enhancing their ability to make informed decisions when interacting with products. The API response is cached for a duration of 4 hours, enhancing performance and minimizing redundant calls.

Pricing and Availability Display Guidelines

🔴 Pricing Handling (MANDATORY)

When the API returns pricing = 0, partners must not display a price of "$0" to end users.

Required Display Message:

"Please call branch for product pricing"

This is a mandatory requirement for all integration partners and aligns with RoofHub behavior.

✅ Availability Messaging (RECOMMENDED)

When the API returns the message "Call branch for availability", it indicates no stock information is available.

Recommended Action: Display this message to users so they know to contact the branch directly.

This is optional but recommended for better user experience.

Reference: RoofHub follows these same display patterns for consistent partner experience.

Request

Header Params

Body Params application/json

Example

{
  "sourceSystem": "SOURCENAME",
  "customerCode": "DEMO001",
  "branchCode": "HWPLY",
  "transactionId": "SPR-1",
  "jobAccountNumber": 1,
  "productList": [
    {
      "productId": 77673,
      "productName": "Ace Insulation Plates",
      "productOptions": [
        "N/A"
      ],
      "quantity": 1,
      "uom": "PC"
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200v2/price

application/json

Bodyapplication/json

Example

[
    {
        "itemCode": "ACEACEPLT3INI",
        "productId": 77673,
        "productName": "Ace Insulation Plates",
        "productOptions": [
            "N/A"
        ],
        "priceUOM": "PC",
        "requestedUOM": "PC",
        "uomConversionFactor": 1,
        "price": 0.25,
        "availableStatus": "Call for Availability",
        "transactionId": "SPR-1",
        "message": "",
        "messageCode": 0
    }
]

Pricing and Availability Display Guidelines#

Request

Request Code Samples

Responses

Pricing and Availability Display Guidelines