Get a stock supplier
Get a stock supplier by its id (required scope stock:read)
Path Parameters
Possible values: >= 1
The unique identifier of the stock details entity
Possible values: >= 1
The unique identifier of the stock supplier
Header Parameters
The customer identifier
- 200
- 400
- 403
- 404
- 500
Success
Schema
- eur: Euro
- aud: Australian Dollar
- gbp: Pound Sterling
- bgn: Bulgarian Lev
- cad: Canadian Dollar
- czk: Czech Koruna
- dkk: Danish Krone
- huf: Forint
- ils: New Israeli Sheqel
- lvl: Latvian Lats - replaced by Euro
- ltl: Lithuanian Litas - replaced by Euro
- mxn: Mexican Peso
- nzd: New Zealand Dollar
- nok: Norwegian Krone
- pln: Zloty
- ron: Romanian Leu
- rub: Russian Ruble
- zar: Rand
- sek: Swedish Krona
- chf: Swiss Franc
- aed: UAE Dirham
- usd: US Dollar
- unknown: Unknown currency
The unique identifier of the stock supplier
The unique identifier of the stock details record
The unique identifier of the contact for this stock supplier
The warranty period refers to the duration (in months) for which the stock supplier guarantees the inventory's quality and performance
The cost refers to the amount charged by the stock supplier for each unit of inventory
Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd, unknown]
Currency definitions enum, matches currencies available in the BigChange Client Site with an unknown value to handle unrecognised currencies returned from the database
Possible values:
{
"id": 12345,
"stockDetailsId": 4334,
"contactId": 88112,
"warrantyPeriod": 12,
"cost": 12.99,
"currencyCode": "eur"
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Forbidden
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Not Found
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Server Error
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}