Skip to content

Ship To Master

GET    /api/ship-to-master
GET    /api/ship-to-master/{id}
POST   /api/ship-to-master
PUT    /api/ship-to-master/{id}
DELETE /api/ship-to-master/{id}

Required privilege: Customer Master / View (read) ยท Customer Master / Edit (write)

Ship To locations represent delivery destinations associated with a customer.

Ship To Object

{
  "id": 9,
  "Ship To Number": "ST-09",
  "Ship To Name": "Beta East Warehouse",
  "Ship To Address": "456 Commerce Dr, Philadelphia, PA",
  "Ship To Status": "Active",
  "Customer Id": 4,
  "Customer Number": "CUST-004",
  "Ship To Servicenow Id": null
}

POST - Create Ship To

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

{
  "Ship To Number": "ST-NEW",
  "Ship To Name": "Beta West DC",
  "Customer Number": "CUST-004",
  "Ship To Status": "Active"
}

Errors

Status Code Description
400 ShipToMaster.NotFound No location with this ID
400 ShipToMaster.StillInUse Location referenced by orders
403 User.NotPrivileged Insufficient privilege