Ship From Master¶
GET /api/ship-from-master
GET /api/ship-from-master/{id}
POST /api/ship-from-master
PUT /api/ship-from-master/{id}
DELETE /api/ship-from-master/{id}
Required privilege: Supplier Master / View (read) ยท Supplier Master / Edit (write)
Ship From locations represent the physical origin points from which a supplier ships goods. Each Ship From is associated with a parent supplier.
Ship From Object¶
{
"id": 8,
"Ship From Number": "SF-01",
"Ship From Name": "Acme East Plant",
"Ship From Address": "123 Industrial Blvd, Newark, NJ",
"Ship From Status": "Active",
"Supplier Id": 7,
"Supplier Number": "SUP-007",
"Ship From Servicenow Id": null
}
| Field | Type | Description |
|---|---|---|
id |
integer | Internal identifier |
Ship From Number |
string | Unique reference code |
Ship From Name |
string | Display name |
Supplier Id |
integer | Parent supplier ID |
Supplier Number |
string | Parent supplier reference |
Ship From Servicenow Id |
string | null | External ServiceNow reference |
POST - Create Ship From¶
POST /api/ship-from-master HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>
{
"Ship From Number": "SF-NEW",
"Ship From Name": "Acme West Plant",
"Supplier Number": "SUP-007",
"Ship From Status": "Active"
}
Errors¶
| Status | Code | Description |
|---|---|---|
| 400 | ShipFromMaster.NotFound |
No location with this ID |
| 400 | ShipFromMaster.StillInUse |
Location referenced by orders |
| 403 | User.NotPrivileged |
Insufficient privilege |