Retrieve a product

1 min

GET

https://api.fictive.com/REST/api/products/{productReference}

Calling this endpoint will retrieve a single instance of a configured product within eSuite.

Path Parameters

productReferencestringrequired

Header Parameters

X-TokenIdstring
Description
The eSuite Token Id
X-SessionIdstring
Description
The eSuite Session Id
X-Versionstringrequired
Description
The eSuite Version
Originstring
Description
The eSuite Origin

Responses

200OK

FictiveGlobal.Api.Rest.Dtos.v1.ProductResponse
Description
Response dto for Products.
- productReferencestring
- namestring
- descriptionstring
- typestring
- statusstring
- productListReferencesstring[]
  Example
- createdDatestring<date-time>
  Example
  2021-09-21T05:33:23.2761237
- lastUpdatedDatestring<date-time>
  Example
  2021-09-21T05:33:23.2761237
- productParametersobject
  Example
  [object Object]
- pricingFictiveGlobal.Api.Rest.Dtos.v1.PricePointResponse[]
  Description
  Response DTO V1 for the Product Price Point.
  - rolestring
    Description
    Gets or sets the Role name
  - amountnumber<double>
    Description
    Gets or sets the Amount
  - isGrossboolean
    Description
    Specify whether is gross amount
  - priceReferencestring
    Description
    Unique price reference
  - taxCategorystring
    Description
    Tax category name
  - paymentMethodstring
    Description
    Payment method name
  - currencystring
    Description
    Three letter currency ISO code
- imagesFictiveGlobal.Api.Rest.Dtos.v1.ImageResponse[]
  Description
  Response dto for Images.
  - imageReferencestring
  - displayNamestring
  - fileLocationstring
  - defaultImageboolean
- creditsFictiveGlobal.Api.Rest.Dtos.v1.CreditResponse[]
  Description
  Response dto for Credits.
  - creditsReferencestring
  - currencystring
  - amountnumber<double>
  - expiryDatestring<date-time>
  - expiryDaysinteger<int32>
- contractPricingFictiveGlobal.Api.Rest.Dtos.v1.ProductService[]
  Description
  ProductService is a link between a product and a contract(service)
  - contractReferencestring
    Description
    The contract reference
  - pricingFictiveGlobal.Api.Rest.Dtos.v1.ProductServicePricing[]
    Description
    Pricing information
    - productContractPriceReferencestring
      Description
      The identifier of the price
    - taxCategoryFictiveGlobal.Api.Rest.Dtos.v1.TaxCategory
      Description
      Tax category information
      - taxCategoryReferencestring
        Description
        Tax category reference
      - taxCategoryNamestring
        Description
        Tax category name
      - displayNamestring
        Description
        Tax category name to display
    - amountFictiveGlobal.Api.Rest.Dtos.v3.CartLineItems.PricePoint
      Description
      Pricing information
      - grossAmountnumber<double>
        Description
        Gross Amount
      - netAmountnumber<double>
        Description
        Net Amount
      - taxAmountnumber<double>
        Description
        Tax Amount
      - currencystring
        Description
        Currency
      - priceReferencestring
        Description
        Product Price Reference
    - activeboolean

401Not Authorized

404Product cannot be found

500Internal Server Error

curl

curl --request GET \
     --url https://api.fictive.com/REST/api/products/{productReference} \
     --header 'accept: application/json' \
     --header 'x-version: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-version", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.fictive.com/REST/api/products/{productReference}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.fictive.com/REST/api/products/{productReference}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-version"] = "string"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.fictive.com/REST/api/products/{productReference}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-version': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "productReference": "0010BBLEC8GZAZA853",
  "name": "Product A",
  "description": "Product A Description",
  "type": "Physical",
  "status": "Active",
  "productListReferences": [
    "001PLYVMOL3WIA13S1"
  ],
  "createdDate": "2021-09-21T05:33:24.5105213",
  "lastUpdatedDate": "2021-09-21T05:33:24.5105213",
  "productParameters": {
    "ParameterName1": "ParameterValue1",
    "ParameterName2": "ParameterValue2",
    "ParameterName3": "ParameterValue3"
  },
  "pricing": [
    {
      "role": "Default",
      "amount": 22,
      "isGross": true,
      "priceReference": "0010FN2NS2K63HEHC0",
      "taxCategory": "Standard",
      "paymentMethod": "ServiceCredits",
      "currency": "GBP"
    }
  ],
  "images": [
    {
      "imageReference": "001IMALAKTOTN3DGB2",
      "displayName": "Image1",
      "fileLocation": "https://www.ImageLocation.co.uk/ImageFolder/Image1.jpg",
      "defaultImage": true
    }
  ],
  "credits": [
    {
      "creditsReference": "001PCHCHYYG8VN4632",
      "currency": "GBP",
      "amount": 10,
      "expiryDate": "2021-10-21T05:33:24.5105213"
    }
  ]
}

401

// Not Authorized

404

// Product cannot be found

500

// Internal Server Error

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.