Create a stock supplier

Create a new stock supplier (required scope stock:write)

Path Parameters

stockDetailsId int64 required

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body required

contactId int64 required

The unique identifier of the contact that supplies the stock

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. If CurrencyCode is not null, this field is required

currencyCode CurrencyWrite

Possible values: [eur, aud, gbp, bgn, cad, czk, dkk, huf, ils, lvl, ltl, mxn, nzd, nok, pln, ron, rub, zar, sek, chf, aed, usd]

Currency definitions enum, matches currencies available in the BigChange Client Site

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

Responses

• 201
• 400
• 403
• 404
• 422
• 500

---

Created

application/json

Schema

Example (from schema)

---

Schema

id int64

Identifier of the newly created record

{
  "id": 0
}

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

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
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

{
  "errors": {},
  "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...