Get a list of stock suppliers

Retrieves a paged collection of stock suppliers (required scope stock:read)

Path Parameters

stockDetailsId int64 required

Possible values: >= 1

The unique identifier of the stock details

Query Parameters

id int64[]

Only return notes where id matches the value(s) provided

pageNumber int32

Possible values: >= 1 and <= 2147483

The page number being requested (minimum: 1, maximum: 2147483)

pageSize int32

Possible values: >= 1 and <= 1000

The page size being requested (minimum: 1, maximum: 1000)

Header Parameters

Customer-Id int64 required

The customer identifier

Responses

• 200
• 400
• 403
• 404
• 500

---

Success

application/json

Schema

Example (from schema)

---

Schema

items object[]
The items returned for the requested page
Array [
id int64
The unique identifier of the stock supplier
stockDetailsId int64
The unique identifier of the stock details record
contactId int64
The unique identifier of the contact for this stock supplier
warrantyPeriod int32 nullable
The warranty period refers to the duration (in months) for which the stock supplier guarantees the inventory's quality and performance
cost double nullable
The cost refers to the amount charged by the stock supplier for each unit of inventory
currencyCode CurrencyRead
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:
• 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
]
pageNumber int32

The page number of the response where 1 is the first page

pageSize int32

The number of items requested for the current page

pageItemCount int32

The number of items returned in the current page

{
  "items": [
    {
      "id": 12345,
      "stockDetailsId": 4334,
      "contactId": 88112,
      "warrantyPeriod": 12,
      "cost": 12.99,
      "currencyCode": "eur"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

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

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

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

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

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

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

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"
}

Loading...