Supplier Master¶

GET    /api/supplier-master
GET    /api/supplier-master/{id}
POST   /api/supplier-master
PUT    /api/supplier-master/{id}
DELETE /api/supplier-master/{id}

Required privilege: Supplier Master / View (read) · Supplier Master / Edit (write)

The Supplier Master contains all supplier records. Each supplier may have one or more Ship From locations (see Ship From Master).

Supplier Object¶

{
  "id": 7,
  "Supplier Number": "SUP-007",
  "Supplier Name": "Acme Components Ltd.",
  "Supplier Email": "orders@acme.com",
  "Supplier Phone": "+1 555 200 0000",
  "Supplier Status": "Active",
  "Supplier Servicenow Id": null,
  "Ship From Locations": [
    { "id": 8, "Ship From Number": "SF-01", "Ship From Name": "Acme East Plant" }
  ]
}

Field	Type	Description
`id`	integer	Internal supplier identifier
`Supplier Number`	string	Unique supplier reference code
`Supplier Name`	string	Display name
`Supplier Email`	string \| null	Contact email
`Supplier Phone`	string \| null	Contact phone
`Supplier Status`	string	`Active` or `Inactive`
`Supplier Servicenow Id`	string \| null	External ServiceNow reference
`Ship From Locations`	array	Associated ship-from locations

GET - List Suppliers¶

curl -b cookies.txt "https://acme.knosc.com/api/supplier-master"

GET - Get Supplier¶

curl -b cookies.txt "https://acme.knosc.com/api/supplier-master/7"

POST - Create Supplier¶

POST /api/supplier-master HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Supplier Number": "SUP-NEW",
  "Supplier Name": "New Supplier Inc.",
  "Supplier Email": "contact@newsupplier.com",
  "Supplier Status": "Active"
}

PUT - Update Supplier¶

PUT /api/supplier-master/{id} HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

DELETE - Delete Supplier¶

Cascade deletes all associated Ship From locations.

DELETE /api/supplier-master/{id} HTTP/1.1
X-XSRF-TOKEN: <csrf>

Error: Returns SupplierMaster.StillInUse if the supplier is referenced by purchase orders.

Errors¶

Status	Code	Description
400	`SupplierMaster.NotFound`	No supplier with this ID
400	`SupplierMaster.AlreadyExists`	Supplier Number already in use
400	`SupplierMaster.StillInUse`	Supplier referenced by orders
403	`User.NotPrivileged`	Insufficient privilege