Sign in
Stock

Get a stock supplier

Get a stock supplier by its id (required scope stock:read)

get/v1/stockDetails/{stockDetailsId}/suppliers/{stockSupplierId}

Path parameters

stockDetailsIdinteger required

The unique identifier of the stock details entity

stockSupplierIdinteger required

The unique identifier of the stock supplier

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the stock supplier

stockDetailsIdinteger

The unique identifier of the stock details record

contactIdinteger

The unique identifier of the contact for this stock supplier

warrantyPeriodinteger nullable

The warranty period refers to the duration (in months) for which the stock supplier guarantees the inventory's quality and performance

costnumber double nullable

The cost refers to the amount charged by the stock supplier for each unit of inventory

currencyCode'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' | 'UNKNOWN'

CurrencyCode definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database<p>Possible values:</p><ul><li><b>EUR</b>: Euro</li><li><b>AUD</b>: Australian Dollar</li><li><b>GBP</b>: Pound Sterling</li><li><b>BGN</b>: Bulgarian Lev</li><li><b>CAD</b>: Canadian Dollar</li><li><b>CZK</b>: Czech Koruna</li><li><b>DKK</b>: Danish Krone</li><li><b>HUF</b>: Forint</li><li><b>ILS</b>: New Israeli Sheqel</li><li><b>LVL</b>: Latvian Lats - replaced by Euro</li><li><b>LTL</b>: Lithuanian Litas - replaced by Euro</li><li><b>MXN</b>: Mexican Peso</li><li><b>NZD</b>: New Zealand Dollar</li><li><b>NOK</b>: Norwegian Krone</li><li><b>PLN</b>: Zloty</li><li><b>RON</b>: Romanian Leu</li><li><b>RUB</b>: Russian Ruble</li><li><b>ZAR</b>: Rand</li><li><b>SEK</b>: Swedish Krona</li><li><b>CHF</b>: Swiss Franc</li><li><b>AED</b>: UAE Dirham</li><li><b>USD</b>: US Dollar</li><li><b>UNKNOWN</b>: Unknown currency</li></ul>

Example response

{
  "id": 12345,
  "stockDetailsId": 4334,
  "contactId": 88112,
  "warrantyPeriod": 12,
  "cost": 12.99,
  "currencyCode": "EUR"
}